Merge pull request #96 from magento-trigger/PB-api

[Team 3] Mark code with api annotation

Author: irenelagno

app/code/Magento/PageBuilder/Block/Adminhtml/ContentType/Edit/CancelButton.php

@@ -10,6 +10,11 @@
 
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
+/**
+ * Cancel button on edit panel for Content Type
+ *
+ * @api
+ */
 class CancelButton implements ButtonProviderInterface
 {
     /**

app/code/Magento/PageBuilder/Block/Adminhtml/ContentType/Edit/CloseButton.php

@@ -9,6 +9,11 @@
 
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
+/**
+ * Close button on edit panel for Content Type
+ *
+ * @api
+ */
 class CloseButton implements ButtonProviderInterface
 {
     /**
@@ -31,7 +36,7 @@ public function __construct(string $targetName)
      *
      * @return array
      */
-    public function getButtonData()
+    public function getButtonData() : array
     {
         return [
             'label' => __('Close'),

app/code/Magento/PageBuilder/Block/Adminhtml/ContentType/Edit/ResetButton.php

@@ -3,18 +3,25 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Block\Adminhtml\ContentType\Edit;
 
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
+/**
+ * Reset button on edit panel for Content Type
+ *
+ * @api
+ */
 class ResetButton implements ButtonProviderInterface
 {
     /**
      * Retrieve button data
      *
      * @return array
      */
-    public function getButtonData()
+    public function getButtonData() : array
     {
         return [
             'label' => __('Reset'),

app/code/Magento/PageBuilder/Block/Adminhtml/ContentType/Edit/SaveButton.php

@@ -3,18 +3,25 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Block\Adminhtml\ContentType\Edit;
 
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
+/**
+ * Save button on edit panel for Content Type
+ *
+ * @api
+ */
 class SaveButton implements ButtonProviderInterface
 {
     /**
      * Retrieve button data
      *
      * @return array
      */
-    public function getButtonData()
+    public function getButtonData() : array
     {
         return [
             'label' => __('Save'),

app/code/Magento/PageBuilder/Block/Adminhtml/Form/Element/ProductConditions.php

@@ -12,6 +12,8 @@
 
 /**
  * The block used to render the conditions rule tree form within the PageBuilder interface.
+ *
+ * @api
  */
 class ProductConditions extends Template
 {

app/code/Magento/PageBuilder/Block/Adminhtml/System/Config/EnableField.php

@@ -3,11 +3,17 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
 namespace Magento\PageBuilder\Block\Adminhtml\System\Config;
 
 use Magento\Framework\Data\Form\Element\AbstractElement;
 
+/**
+ * Class EnableField renders modal window if disable PB in System Configuration
+ *
+ * @api
+ */
 class EnableField extends \Magento\Config\Block\System\Config\Form\Field
 {
     /**
@@ -51,9 +57,9 @@ protected function _getElementHtml(AbstractElement $element)
     /**
      * Get text for the modal title heading when user switches to disable
      *
-     * @return string
+     * @return \Magento\Framework\Phrase
      */
-    private function getModalTitleText()
+    private function getModalTitleText() : \Magento\Framework\Phrase
     {
         return __('Are You Sure You Want to Turn Off Page Builder?');
     }

app/code/Magento/PageBuilder/Block/Adminhtml/System/Config/Form/Field/GoogleMapsApiKey.php

@@ -7,6 +7,9 @@
 
 namespace Magento\PageBuilder\Block\Adminhtml\System\Config\Form\Field;
 
+/**
+ * @api
+ */
 class GoogleMapsApiKey extends \Magento\Config\Block\System\Config\Form\Field
 {
     /**

app/code/Magento/PageBuilder/Block/Adminhtml/System/Config/SwitchAttributeType.php

@@ -8,6 +8,10 @@
 
 namespace Magento\PageBuilder\Block\Adminhtml\System\Config;
 
+/**
+ * Class SwitchAttributeType renders modal window to confirm changing attribute type
+ *
+ */
 class SwitchAttributeType extends \Magento\Config\Block\System\Config\Form\Field
 {
     /**
@@ -26,17 +30,17 @@ public function __construct(
      *
      * @return string
      */
-    public function getModalSelector()
+    public function getModalSelector() : string
     {
         return '#frontend_input';
     }
 
     /**
      * Get text for the modal title heading when user switches to disable
      *
-     * @return string
+     * @return \Magento\Framework\Phrase
      */
-    public function getModalTitleText()
+    public function getModalTitleText() : \Magento\Framework\Phrase
     {
         return __('Product data may be lost');
     }
@@ -46,7 +50,7 @@ public function getModalTitleText()
      *
      * @return string
      */
-    public function getModalContentBody()
+    public function getModalContentBody() :string
     {
         $content = __("Changing the Input Type may result in product data loss. Proceed with caution.");
         return '<div class="pagebuilder-modal-content-body">' . $content . '</div>';

app/code/Magento/PageBuilder/Block/ContentType/Block.php

@@ -3,8 +3,13 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Block\ContentType;
 
+/**
+ * @api
+ */
 class Block extends \Magento\Cms\Block\Block
 {
     /**