From 81ec7c910e09db046d03ee48c3b162eb36f2f56f Mon Sep 17 00:00:00 2001 From: tuna Date: Tue, 23 Feb 2021 15:26:02 +0700 Subject: [PATCH] Mark Framework interfaces as API part 9 update update up --- .../Framework/View/File/FileList/CollateInterface.php | 3 +++ .../View/Helper/SecureHtmlRender/EventHandlerData.php | 3 ++- .../Helper/SecureHtmlRender/SecurityProcessorInterface.php | 3 ++- .../Framework/View/Helper/SecureHtmlRender/TagData.php | 3 ++- .../Framework/View/Layout/Argument/UpdaterInterface.php | 4 ++++ .../View/Layout/Condition/VisibilityConditionInterface.php | 6 +++++- .../Magento/Framework/View/Layout/GeneratorInterface.php | 3 +++ .../Framework/View/Layout/LayoutCacheKeyInterface.php | 4 ++++ .../Magento/Framework/View/Layout/ProcessorInterface.php | 4 ++++ .../Magento/Framework/View/Layout/ReaderInterface.php | 3 +++ .../View/Model/PageLayout/Config/BuilderInterface.php | 6 +++++- .../Framework/View/Page/Config/RendererInterface.php | 4 ++-- lib/internal/Magento/Framework/View/PageLayout/Config.php | 3 +++ .../TemplateEngine/Xhtml/Compiler/AttributeInterface.php | 4 ++++ .../View/TemplateEngine/Xhtml/Compiler/CdataInterface.php | 4 ++++ .../TemplateEngine/Xhtml/Compiler/CommentInterface.php | 4 ++++ .../Xhtml/Compiler/Directive/DirectiveInterface.php | 4 ++++ .../Xhtml/Compiler/Element/ElementInterface.php | 4 ++++ .../View/TemplateEngine/Xhtml/Compiler/TextInterface.php | 4 ++++ .../View/TemplateEngine/Xhtml/ResultInterface.php | 4 ++++ .../Magento/Framework/View/TemplateEngineInterface.php | 6 +++++- .../View/Xsd/Media/TypeDataExtractorInterface.php | 4 ++++ .../Webapi/CustomAttribute/PreprocessorInterface.php | 4 ++++ .../Webapi/CustomAttribute/ServiceTypeListInterface.php | 6 ++++++ .../Webapi/Rest/Request/DeserializerInterface.php | 7 ++++--- 25 files changed, 93 insertions(+), 11 deletions(-) diff --git a/lib/internal/Magento/Framework/View/File/FileList/CollateInterface.php b/lib/internal/Magento/Framework/View/File/FileList/CollateInterface.php index 63724d797e317..ce34bd1270539 100644 --- a/lib/internal/Magento/Framework/View/File/FileList/CollateInterface.php +++ b/lib/internal/Magento/Framework/View/File/FileList/CollateInterface.php @@ -3,11 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\Framework\View\File\FileList; /** * View file list collate interface + * + * @api */ interface CollateInterface { diff --git a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/EventHandlerData.php b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/EventHandlerData.php index 9d7afc5211cd2..648ece840cd3a 100644 --- a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/EventHandlerData.php +++ b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/EventHandlerData.php @@ -3,13 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ - declare(strict_types=1); namespace Magento\Framework\View\Helper\SecureHtmlRender; /** * JS event handler data. + * + * @api */ class EventHandlerData { diff --git a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/SecurityProcessorInterface.php b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/SecurityProcessorInterface.php index c02394a17e1aa..4a3baf9d70dee 100644 --- a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/SecurityProcessorInterface.php +++ b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/SecurityProcessorInterface.php @@ -3,13 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ - declare(strict_types=1); namespace Magento\Framework\View\Helper\SecureHtmlRender; /** * Perform security related modifications or logic for HTML being rendered. + * + * @api */ interface SecurityProcessorInterface { diff --git a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/TagData.php b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/TagData.php index c856dae75d023..a460e76104bf9 100644 --- a/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/TagData.php +++ b/lib/internal/Magento/Framework/View/Helper/SecureHtmlRender/TagData.php @@ -3,13 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ - declare(strict_types=1); namespace Magento\Framework\View\Helper\SecureHtmlRender; /** * Tag data to render. + * + * @api */ class TagData { diff --git a/lib/internal/Magento/Framework/View/Layout/Argument/UpdaterInterface.php b/lib/internal/Magento/Framework/View/Layout/Argument/UpdaterInterface.php index 93c6d83dd69ba..e1de9d4cf55b8 100644 --- a/lib/internal/Magento/Framework/View/Layout/Argument/UpdaterInterface.php +++ b/lib/internal/Magento/Framework/View/Layout/Argument/UpdaterInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\Layout\Argument; /** * Interface of value modification with no value loss + * + * @api */ interface UpdaterInterface { diff --git a/lib/internal/Magento/Framework/View/Layout/Condition/VisibilityConditionInterface.php b/lib/internal/Magento/Framework/View/Layout/Condition/VisibilityConditionInterface.php index b91e1ffee04a4..d5f4f82247044 100644 --- a/lib/internal/Magento/Framework/View/Layout/Condition/VisibilityConditionInterface.php +++ b/lib/internal/Magento/Framework/View/Layout/Condition/VisibilityConditionInterface.php @@ -3,10 +3,12 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\Layout\Condition; /** - * Class VisibilityConditionInterface + * Interface VisibilityConditionInterface * * Introduces family of visibility conditions for layout elements. * By using this interface a developer can specify dynamic rule for ui component visibility. @@ -23,6 +25,8 @@ * * * "visibilityCondition" just another optional child element of ui component declaration + * + * @api */ interface VisibilityConditionInterface { diff --git a/lib/internal/Magento/Framework/View/Layout/GeneratorInterface.php b/lib/internal/Magento/Framework/View/Layout/GeneratorInterface.php index 134660dc34568..b17808fc27ae4 100644 --- a/lib/internal/Magento/Framework/View/Layout/GeneratorInterface.php +++ b/lib/internal/Magento/Framework/View/Layout/GeneratorInterface.php @@ -3,11 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\Layout; /** * Interface \Magento\Framework\View\Layout\GeneratorInterface * + * @api */ interface GeneratorInterface { diff --git a/lib/internal/Magento/Framework/View/Layout/LayoutCacheKeyInterface.php b/lib/internal/Magento/Framework/View/Layout/LayoutCacheKeyInterface.php index 1d4bb8aebe882..1ff8a3d354519 100644 --- a/lib/internal/Magento/Framework/View/Layout/LayoutCacheKeyInterface.php +++ b/lib/internal/Magento/Framework/View/Layout/LayoutCacheKeyInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\Layout; /** * Interface LayoutCacheKeyInterface + * + * @api */ interface LayoutCacheKeyInterface { diff --git a/lib/internal/Magento/Framework/View/Layout/ProcessorInterface.php b/lib/internal/Magento/Framework/View/Layout/ProcessorInterface.php index eacbc46a971de..a80f03c7c2eac 100644 --- a/lib/internal/Magento/Framework/View/Layout/ProcessorInterface.php +++ b/lib/internal/Magento/Framework/View/Layout/ProcessorInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\Layout; /** * Interface ProcessorInterface + * + * @api */ interface ProcessorInterface { diff --git a/lib/internal/Magento/Framework/View/Layout/ReaderInterface.php b/lib/internal/Magento/Framework/View/Layout/ReaderInterface.php index 1c3dada6f16d2..d298c3aff9568 100644 --- a/lib/internal/Magento/Framework/View/Layout/ReaderInterface.php +++ b/lib/internal/Magento/Framework/View/Layout/ReaderInterface.php @@ -3,11 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\Layout; /** * Interface \Magento\Framework\View\Layout\ReaderInterface * + * @api */ interface ReaderInterface { diff --git a/lib/internal/Magento/Framework/View/Model/PageLayout/Config/BuilderInterface.php b/lib/internal/Magento/Framework/View/Model/PageLayout/Config/BuilderInterface.php index 0f110246db093..5a7c4739f39de 100644 --- a/lib/internal/Magento/Framework/View/Model/PageLayout/Config/BuilderInterface.php +++ b/lib/internal/Magento/Framework/View/Model/PageLayout/Config/BuilderInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\Model\PageLayout\Config; /** - * Interface BuilderInterface + * Interface Page Layout Config Builder + * + * @api */ interface BuilderInterface { diff --git a/lib/internal/Magento/Framework/View/Page/Config/RendererInterface.php b/lib/internal/Magento/Framework/View/Page/Config/RendererInterface.php index e49c8f141ec24..f343cc48f3755 100644 --- a/lib/internal/Magento/Framework/View/Page/Config/RendererInterface.php +++ b/lib/internal/Magento/Framework/View/Page/Config/RendererInterface.php @@ -3,13 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\Framework\View\Page\Config; /** * Interface RendererInterface * - * @package Magento\Framework\View\Page\Config + * @api */ interface RendererInterface { @@ -17,7 +18,6 @@ interface RendererInterface * Render Element Attributes * * @param string $elementType - * * @return string */ public function renderElementAttributes($elementType); diff --git a/lib/internal/Magento/Framework/View/PageLayout/Config.php b/lib/internal/Magento/Framework/View/PageLayout/Config.php index ba00e6beeda8e..8743209a10087 100644 --- a/lib/internal/Magento/Framework/View/PageLayout/Config.php +++ b/lib/internal/Magento/Framework/View/PageLayout/Config.php @@ -3,11 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\Framework\View\PageLayout; /** * Page layouts configuration + * + * @api */ class Config extends \Magento\Framework\Config\AbstractXml { diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/AttributeInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/AttributeInterface.php index c682fff45246d..9db9414d3cc55 100644 --- a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/AttributeInterface.php +++ b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/AttributeInterface.php @@ -3,12 +3,16 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler; use Magento\Framework\DataObject; /** * Interface AttributeInterface + * + * @api */ interface AttributeInterface { diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CdataInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CdataInterface.php index 303a67c80b94d..46db057a8814c 100644 --- a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CdataInterface.php +++ b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CdataInterface.php @@ -3,12 +3,16 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler; use Magento\Framework\DataObject; /** * Interface CdataInterface + * + * @api */ interface CdataInterface { diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CommentInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CommentInterface.php index 4b54d74d1e3e0..442cfd634e5ba 100644 --- a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CommentInterface.php +++ b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/CommentInterface.php @@ -3,12 +3,16 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler; use Magento\Framework\DataObject; /** * Interface CommentInterface + * + * @api */ interface CommentInterface { diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Directive/DirectiveInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Directive/DirectiveInterface.php index dce2d3dfb4348..c4c1cbe10fec3 100644 --- a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Directive/DirectiveInterface.php +++ b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Directive/DirectiveInterface.php @@ -3,12 +3,16 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler\Directive; use Magento\Framework\DataObject; /** * Interface DirectiveInterface + * + * @api */ interface DirectiveInterface { diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Element/ElementInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Element/ElementInterface.php index 994b8848af416..68147617aefd1 100644 --- a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Element/ElementInterface.php +++ b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/Element/ElementInterface.php @@ -3,6 +3,8 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler\Element; use Magento\Framework\DataObject; @@ -10,6 +12,8 @@ /** * Interface ElementInterface + * + * @api */ interface ElementInterface { diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/TextInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/TextInterface.php index 4295b10e6b87b..994b30e64f982 100644 --- a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/TextInterface.php +++ b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/Compiler/TextInterface.php @@ -3,12 +3,16 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\TemplateEngine\Xhtml\Compiler; use Magento\Framework\DataObject; /** * Interface TextInterface + * + * @api */ interface TextInterface { diff --git a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/ResultInterface.php b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/ResultInterface.php index e7583cac16ffe..78cd7cba7e92a 100644 --- a/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/ResultInterface.php +++ b/lib/internal/Magento/Framework/View/TemplateEngine/Xhtml/ResultInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\TemplateEngine\Xhtml; /** * Interface ResultInterface + * + * @api */ interface ResultInterface { diff --git a/lib/internal/Magento/Framework/View/TemplateEngineInterface.php b/lib/internal/Magento/Framework/View/TemplateEngineInterface.php index 30c653229c2c7..57c287af02fe3 100644 --- a/lib/internal/Magento/Framework/View/TemplateEngineInterface.php +++ b/lib/internal/Magento/Framework/View/TemplateEngineInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View; /** * Interface for Template Engine + * + * @api */ interface TemplateEngineInterface { @@ -19,7 +23,7 @@ interface TemplateEngineInterface * @param \Magento\Framework\View\Element\BlockInterface $block * @param string $templateFile * @param array $dictionary - * @return string rendered template + * @return string */ public function render( \Magento\Framework\View\Element\BlockInterface $block, diff --git a/lib/internal/Magento/Framework/View/Xsd/Media/TypeDataExtractorInterface.php b/lib/internal/Magento/Framework/View/Xsd/Media/TypeDataExtractorInterface.php index 2472e6ecfe20a..8deb45872e689 100644 --- a/lib/internal/Magento/Framework/View/Xsd/Media/TypeDataExtractorInterface.php +++ b/lib/internal/Magento/Framework/View/Xsd/Media/TypeDataExtractorInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\View\Xsd\Media; /** * Interface that encapsulates complexity of expression computation + * + * @api */ interface TypeDataExtractorInterface { diff --git a/lib/internal/Magento/Framework/Webapi/CustomAttribute/PreprocessorInterface.php b/lib/internal/Magento/Framework/Webapi/CustomAttribute/PreprocessorInterface.php index 8de30e92218c0..c1f7afceb7570 100644 --- a/lib/internal/Magento/Framework/Webapi/CustomAttribute/PreprocessorInterface.php +++ b/lib/internal/Magento/Framework/Webapi/CustomAttribute/PreprocessorInterface.php @@ -3,10 +3,14 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); + namespace Magento\Framework\Webapi\CustomAttribute; /** * Interface for attribute preprocessor + * + * @api */ interface PreprocessorInterface { diff --git a/lib/internal/Magento/Framework/Webapi/CustomAttribute/ServiceTypeListInterface.php b/lib/internal/Magento/Framework/Webapi/CustomAttribute/ServiceTypeListInterface.php index 37cf6849a32f9..e461843626823 100644 --- a/lib/internal/Magento/Framework/Webapi/CustomAttribute/ServiceTypeListInterface.php +++ b/lib/internal/Magento/Framework/Webapi/CustomAttribute/ServiceTypeListInterface.php @@ -3,9 +3,15 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ +declare(strict_types=1); namespace Magento\Framework\Webapi\CustomAttribute; +/** + * ServiceTypeListInterface interface + * + * @api + */ interface ServiceTypeListInterface { /** diff --git a/lib/internal/Magento/Framework/Webapi/Rest/Request/DeserializerInterface.php b/lib/internal/Magento/Framework/Webapi/Rest/Request/DeserializerInterface.php index 70a30a68b93e7..9d39a77898de9 100644 --- a/lib/internal/Magento/Framework/Webapi/Rest/Request/DeserializerInterface.php +++ b/lib/internal/Magento/Framework/Webapi/Rest/Request/DeserializerInterface.php @@ -1,15 +1,16 @@