Skip to content

Marked classes and interfaces as API #32129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
1 change: 1 addition & 0 deletions app/code/Magento/Customer/Controller/RegistryConstants.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Declarations of core registry keys used by the Customer module
*
* @api
*/
class RegistryConstants
{
Expand Down
5 changes: 5 additions & 0 deletions app/code/Magento/Customer/Model/Context.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
*/
namespace Magento\Customer\Model;

/**
* Class Context
*
* @api
*/
class Context
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
*/
namespace Magento\Sales\Model\ResourceModel\Order\Collection;

/**
* Class Factory
*
* @api
*/
class Factory
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Interface \Magento\Shipping\Model\Carrier\CarrierInterface
*
* @api
*/
interface CarrierInterface
{
Expand Down
2 changes: 2 additions & 0 deletions app/code/Magento/Ui/Component/Layout/Tabs/TabInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Interface TabInterface
*
* @api
*/
interface TabInterface
{
Expand Down
1 change: 1 addition & 0 deletions app/code/Magento/Widget/Block/BlockInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* Widget Block Interface
*
* @author Magento Core Team <core@magentocommerce.com>
* @api
*/
namespace Magento\Widget\Block;

Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Api/AbstractSimpleObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
/**
* Base Class for simple data Objects
* @SuppressWarnings(PHPMD.NumberOfChildren)
*
* @api
*/
abstract class AbstractSimpleObject
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@

namespace Magento\Framework\App\Action;

use Magento\Framework\App\ActionInterface;

/**
* Marker for actions processing GET requests.
*
* @api
*/
interface HttpGetActionInterface extends HttpHeadActionInterface
interface HttpGetActionInterface extends ActionInterface
{

}
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Marker for actions processing POST requests.
*
* @api
*/
interface HttpPostActionInterface extends ActionInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

/**
* Action that's aware of CSRF protection.
*
* @api
*/
interface CsrfAwareActionInterface extends ActionInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* A Magento application specific list of directories
*
* @api
*/
class DirectoryList extends \Magento\Framework\Filesystem\DirectoryList
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/App/Http/Context.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

/**
* Context data for requests
*
* @api
*/
class Context
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

/**
* Received request is invalid.
*
* @api
*/
class InvalidRequestException extends RuntimeException
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

/**
* Class FileFactory serves to declare file content in response for download.
*
* @api
*/
class FileFactory
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
/**
* Interface \Magento\Framework\App\Response\RedirectInterface
*
* @api
*/
interface RedirectInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Factory class for @see \Magento\Framework\Controller\Result\Json
*
* @api
*/
class JsonFactory
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Controller/Result/Raw.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
/**
* A result that contains raw response - may be good for passing through files,
* returning result of downloads or some other binary contents
*
* @api
*/
class Raw extends AbstractResult
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Data/FormFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

/**
* Form factory class
*
* @api
*/
class FormFactory
{
Expand Down
5 changes: 5 additions & 0 deletions lib/internal/Magento/Framework/DataObject/Factory.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
*/
namespace Magento\Framework\DataObject;

/**
* Class Factory
*
* @api
*/
class Factory
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
* Interface for
* 1. models which require cache refresh when it is created/updated/deleted
* 2. blocks which render this information to front-end
*
* @api
*/
interface IdentityInterface
{
Expand Down
1 change: 1 addition & 0 deletions lib/internal/Magento/Framework/Event/ManagerInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/**
* Interface \Magento\Framework\Event\ManagerInterface
*
* @api
*/
interface ManagerInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Filesystem/DirectoryList.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
* This object is intended to be immutable (a "value object").
* The defaults are pre-defined and can be modified only by inheritors of this class.
* Through the constructor, it is possible to inject custom paths or URL paths, but impossible to inject new types.
*
* @api
*/
class DirectoryList
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/Logger/Handler/Base.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* Base stream handler
*
* @api
*/
class Base extends StreamHandler
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/View/Element/Html/Select.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* HTML select element block
*
* @api
*/
class Select extends \Magento\Framework\View\Element\AbstractBlock
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

/**
* Interface ContextInterface
*
* @api
*/
interface ContextInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Interface ButtonProviderInterface
*
* @api
*/
interface ButtonProviderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

/**
* Class DataProvider
*
* @api
*/
class DataProvider implements DataProviderInterface
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
* Class SearchResult
* Generic Search Result
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @api
*/
class SearchResult extends AbstractCollection implements Api\Search\SearchResultInterface
{
Expand Down
2 changes: 2 additions & 0 deletions lib/internal/Magento/Framework/View/LayoutFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

/**
* Factory class for Layout
*
* @api
*/
class LayoutFactory
{
Expand Down