Skip to content

Commit

Permalink
[DOCS] Move deprecations section on separate page
Browse files Browse the repository at this point in the history
  • Loading branch information
brotkrueml committed Apr 22, 2020
1 parent fffc439 commit 9536142
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 49 deletions.
49 changes: 0 additions & 49 deletions Documentation/Developer/Api.rst
Expand Up @@ -434,52 +434,3 @@ Parameter

Return value
Array, sorted alphabetically by type name.


.. index:: Deprecations

.. _api-deprecations:

Deprecations
============

.. option:: Brotkrueml\Schema\Core\Model\AbstractType->isEmpty()

Deprecated since version
1.7.0

Will be removed in version
2.0.0

Alternative
None. If you need it use
:php:`Brotkrueml\Schema\Core\Model\AbstractType->getPropertyNames()`
and loop over the property names with
:php:`Brotkrueml\Schema\Core\Model\AbstractType->getProperty()`.


.. option:: Brotkrueml\Schema\Manager\SchemaManager->setMainEntityOfWebPage()

Deprecated since version
1.4.1

Will be removed in version
2.0.0

Alternative
Use :php:`Brotkrueml\Schema\Manager\SchemaManager->addMainEntityOfWebPage()`
instead. See the :ref:`API <api-schema-manager-addmainentityofwebpage>`.


.. option:: Brotkrueml\Schema\Provider\TypesProvider

Deprecated since version
1.7.0

Will be removed in version
2.0.0

Alternative
Use :php:`Brotkrueml\Schema\Type\TypeRegistry` which is a singleton
and can be instantiated with :php:`GeneralUtility::makeInstance()` or in
TYPO3 v10+ via dependency injection. See section :ref:`api-list-of-types`.
51 changes: 51 additions & 0 deletions Documentation/Developer/Deprecations.rst
@@ -0,0 +1,51 @@
.. include:: ../Includes.txt

.. index:: Deprecations

.. _api-deprecations:

============
Deprecations
============

.. option:: Brotkrueml\Schema\Core\Model\AbstractType->isEmpty()

Deprecated since version
1.7.0

Will be removed in version
2.0.0

Alternative
None. If you need it use
:php:`Brotkrueml\Schema\Core\Model\AbstractType->getPropertyNames()`
and loop over the property names with
:php:`Brotkrueml\Schema\Core\Model\AbstractType->getProperty()`.


.. option:: Brotkrueml\Schema\Manager\SchemaManager->setMainEntityOfWebPage()

Deprecated since version
1.4.1

Will be removed in version
2.0.0

Alternative
Use :php:`Brotkrueml\Schema\Manager\SchemaManager->addMainEntityOfWebPage()`
instead. See the :ref:`API <api-schema-manager-addmainentityofwebpage>`.


.. option:: Brotkrueml\Schema\Provider\TypesProvider

Deprecated since version
1.7.0

Will be removed in version
2.0.0

Alternative
Use :php:`Brotkrueml\Schema\Type\TypeRegistry` which is a singleton
and can be instantiated with :php:`GeneralUtility::makeInstance()` or
injected with dependency injection in TYPO3 v10+. See section
:ref:`api-list-of-types`.
1 change: 1 addition & 0 deletions Documentation/Index.rst
Expand Up @@ -98,6 +98,7 @@ on the top right to submit your change request.
Developer/MainEntity
Developer/Events
Developer/ExtendingVocabulary
Developer/Deprecations


.. toctree::
Expand Down

0 comments on commit 9536142

Please sign in to comment.