Version with sitemap for cobblers

Reference/Cobblers/Attributes/CreatePhpdoc.rst

@@ -0,0 +1,75 @@
+.. _attributes-createphpdoc:
+
+.. _create-phpdoc:
+
+Create Phpdoc
++++++++++++++
+Create PHPdoc comments for classes, interfaces, traits, methods and functions.
+
+Parameters and return types are collected, along with the name of the structure.
+
+
+.. _create-phpdoc-before:
+
+Before
+______
+.. code-block:: php
+
+   <?php
+   
+   class y {
+       function a1(string $error, R $r = null) : int|string
+       {
+   
+       }
+   ?>
+
+.. _create-phpdoc-after:
+
+After
+_____
+.. code-block:: php
+
+   <?php
+   
+   /**
+    * Name : y
+    */
+   class y {
+      /**
+       * Name : a1
+       *
+       * string $error
+       * null|R $r
+       * @return int|string
+       *
+       */
+       function a1(string $error, R $r = null) : int|string
+       {
+   
+       }
+   ?>
+
+.. _create-phpdoc-reverse-cobbler:
+
+Reverse Cobbler
+_______________
+
+* :ref:`No anchor for Attributes/RemovePhpdoc <no-anchor-for-attributes-removephpdoc>`
+
+
+
+.. _create-phpdoc-specs:
+
+Specs
+_____
+
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Short Name     | Attributes/CreatePhpdoc                                                                                                 |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Exakat version | 2.3.0                                                                                                                   |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Available in   | `Entreprise Edition <https://www.exakat.io/entreprise-edition>`_, `Exakat Cloud <https://www.exakat.io/exakat-cloud/>`_ |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+
+

Reference/Cobblers/Attributes/RemoveAttribute.rst

@@ -0,0 +1,55 @@
+.. _attributes-removeattribute:
+
+.. _remove-the-attribute:
+
+Remove The Attribute
+++++++++++++++++++++
+Remove attributes from all supporting structures.
+
+Attributes are located on functions, classes, class constants, properties, methods and arguments.
+
+
+.. _remove-the-attribute-before:
+
+Before
+______
+.. code-block:: php
+
+   <?php
+   
+   #[Attribute] 
+   function foo(#[AttributeArgument] $arg) {
+   
+   }
+   ?>
+
+.. _remove-the-attribute-after:
+
+After
+_____
+.. code-block:: php
+
+   <?php
+   
+   
+   function foo($arg) {
+   
+   }
+   ?>
+
+
+
+.. _remove-the-attribute-specs:
+
+Specs
+_____
+
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Short Name     | Attributes/RemoveAttribute                                                                                              |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Exakat version | 2.3.0                                                                                                                   |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Available in   | `Entreprise Edition <https://www.exakat.io/entreprise-edition>`_, `Exakat Cloud <https://www.exakat.io/exakat-cloud/>`_ |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+
+

Reference/Cobblers/Classes/AddFinalClass.rst

@@ -0,0 +1,73 @@
+.. _classes-addfinalclass:
+
+.. _add-final-class:
+
+Add Final Class
++++++++++++++++
+Adds ``final`` keyword to classes that can suppport it.
+
+
+.. _add-final-class-before:
+
+Before
+______
+.. code-block:: php
+
+   <?php
+   
+   class x {
+       // this class is not extended, so it might be final
+   }
+   
+   ?>
+
+.. _add-final-class-after:
+
+After
+_____
+.. code-block:: php
+
+   <?php
+   
+   final class x {
+   }
+   
+   ?>
+
+.. _add-final-class-suggested-analysis:
+
+Suggested Analysis
+__________________
+
+* :ref:`class-could-be-final`
+
+.. _add-final-class-related-cobbler:
+
+Related Cobblers
+________________
+
+* :ref:`No anchor for Classes/AddFinalConstant <no-anchor-for-classes-addfinalconstant>`
+
+.. _add-final-class-reverse-cobbler:
+
+Reverse Cobbler
+_______________
+
+* :ref:`remove-final`
+
+
+
+.. _add-final-class-specs:
+
+Specs
+_____
+
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Short Name     | Classes/AddFinalClass                                                                                                   |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Exakat version | 2.3.0                                                                                                                   |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Available in   | `Entreprise Edition <https://www.exakat.io/entreprise-edition>`_, `Exakat Cloud <https://www.exakat.io/exakat-cloud/>`_ |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+
+

Reference/Cobblers/Classes/ChangeClass.rst

@@ -0,0 +1,87 @@
+.. _classes-changeclass:
+
+.. _change-class:
+
+Change Class
+++++++++++++
+This cobbler replaces a class by another one, and leave the original class intact.
+
+This cobbler is useful for inserting new classes instead of native PHP or library related ones: the usage shall be changed, but not the definition. 
+
+It might also be useful to update code, but keep older classes available for backward compatibility or fallback strategies.
+
+
+.. _change-class-before:
+
+Before
+______
+.. code-block:: php
+
+   <?php
+   
+   class oldClass {}
+   
+   $a = new oldClass;
+   
+   ?>
+
+.. _change-class-after:
+
+After
+_____
+.. code-block:: php
+
+   <?php
+   
+   class oldClass {}
+   
+   $a = new newClass;
+   
+   ?>
+
+
+.. _change-class-destinationname:
+
+Parameters
+__________
+
++-----------------+---------+------+-------------------------------------------------------------------+
+| Name            | Default | Type | Description                                                       |
++-----------------+---------+------+-------------------------------------------------------------------+
+| origin          |         | name | The full namespace path name of the class to target.              |
++-----------------+---------+------+-------------------------------------------------------------------+
+| newClass        |         | name | The full namespace path name of the class to use.                 |
++-----------------+---------+------+-------------------------------------------------------------------+
+| destinationName |         | name | The name of the class to use. This may be used as an import alias |
++-----------------+---------+------+-------------------------------------------------------------------+
+
+.. _change-class-related-cobbler:
+
+Related Cobblers
+________________
+
+* :ref:`rename-class`
+
+.. _change-class-reverse-cobbler:
+
+Reverse Cobbler
+_______________
+
+* :ref:`change-class`
+
+
+
+.. _change-class-specs:
+
+Specs
+_____
+
++----------------+---------------------+
+| Short Name     | Classes/ChangeClass |
++----------------+---------------------+
+| Exakat version | 2.3.0               |
++----------------+---------------------+
+| Available in   |                     |
++----------------+---------------------+
+
+

Reference/Cobblers/Classes/RemoveAbstract.rst

@@ -0,0 +1,53 @@
+.. _classes-removeabstract:
+
+.. _remove-abstract:
+
+Remove Abstract
++++++++++++++++
+Remove the abstract option, from classes and methods.
+
+
+.. _remove-abstract-before:
+
+Before
+______
+.. code-block:: php
+
+   <?php
+   abstract class x {
+       function foo() {}
+       
+       abstract function moo() ;
+   }
+   ?>
+
+.. _remove-abstract-after:
+
+After
+_____
+.. code-block:: php
+
+   <?php
+   class x {
+       function foo() {}
+       
+       function moo() {}
+   }
+   ?>
+
+
+
+.. _remove-abstract-specs:
+
+Specs
+_____
+
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Short Name     | Classes/RemoveAbstract                                                                                                  |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Exakat version | 2.3.0                                                                                                                   |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+| Available in   | `Entreprise Edition <https://www.exakat.io/entreprise-edition>`_, `Exakat Cloud <https://www.exakat.io/exakat-cloud/>`_ |
++----------------+-------------------------------------------------------------------------------------------------------------------------+
+
+