.. include:: /Includes.rst.txt

.. _sphinxcontrib-PHP-Domain:

========================
Phpdomain
========================

.. seealso::

   *  Find the original Sphinx extension at PyPi, the Python Package Index:
      `sphinxcontrib-phpdomain
      <https://pypi.org/project/sphinxcontrib-phpdomain/>`__.

   *  We are using a fork and the branch `develop-for-typo3
      <https://github.com/TYPO3-Documentation/sphinxcontrib-phpdomain/tree/develop-for-typo3>`__


.. contents:: This page
   :backlinks: top
   :class: compact-list
   :depth: 99
   :local:


The PHP Index pages
===================

Two extra index pages are created for the PHP domain.

File :file:`php-modindex.html`
   This one is the "module index" and lists the namespaces.

File :file:`php-objectsindex.html`
   This index contains all known PHP objects.

When index files come into play, you can reference them by using the reference
textrole and the apropriate target name:

============================  ========================
reST source                   rendering
============================  ========================
``:ref:`php-modindex```       :ref:`php-modindex`
``:ref:`php-objectsindex```   :ref:`php-objectsindex`
============================  ========================


Quick Sample
------------

This is source:

.. code-block:: rst

   .. php:class:: DateTime

      Datetime class

      .. php:method:: setDate($year, $month, $day)

         Set the date.

         :param int $year: The year.
         :param int $month: The month.
         :param int $day: The day.
         :returns: Either false on failure, or the datetime object for method chaining.


      .. php:method:: setTime($hour, $minute[, $second])

         Set the time.

         :param int $hour: The hour
         :param int $minute: The minute
         :param int $second: The second
         :returns: Either false on failure, or the datetime object for method chaining.

      .. php:const:: ATOM

         Y-m-d\TH:i:sP


.. php:class:: DateTime

   Datetime class

   .. php:method:: setDate($year, $month, $day)

      Set the date.

      :param int $year: The year.
      :param int $month: The month.
      :param int $day: The day.
      :returns: Either false on failure, or the datetime object for method chaining.


   .. php:method:: setTime($hour, $minute[, $second])

      Set the time.

      :param int $hour: The hour
      :param int $minute: The minute
      :param int $second: The second
      :returns: Either false on failure, or the datetime object for method chaining.

   .. php:const:: ATOM

      Y-m-d\TH:i:sP



Acceptance tests for PHPdomain
------------------------------

Credit: The source for this section was taken from the original `GitHub
repository markstory/sphinxcontrib-phpdomain
<https://github.com/markstory/sphinxcontrib-phpdomain>`__.


Globals
=======

.. php:global:: $global_var

   A global variable

.. php:const:: SOME_CONSTANT

   A global constant

.. php:const:: VALUE

   A global constant

.. php:function:: in_array(needle, haystack)

   Checks for needle in haystack.

   :param needle: The element to search for.
   :param array haystack: The array to search.
   :returns: Element exists in array.
   :returntype: boolean


Classes
=======

.. php:class:: DateTime

   Datetime class

   .. php:method:: setDate($year, $month, $day)

      Set the date in the datetime object

      :param int $year: The year.
      :param int $month: The month.
      :param int $day: The day.

   .. php:method:: setTime($hour, $minute[, $second])

      Set the time

      :param int $hour: The hour
      :param int $minute: The minute
      :param int $second: The second

   .. php:method:: public static getLastErrors()

      Returns the warnings and errors

      :returns: array Returns array containing info about warnings and errors.

   .. php:const:: ATOM

      Y-m-d\TH:i:sP

   .. php:attr:: testattr

      Value of some attribute

.. php:class:: OtherClass

   Another class

.. php:method:: update($arg = '', $arg2 = [], $arg3 = [])

   Update something.

.. php:attr:: nonIndentedAttribute

   This attribute wasn't indented

.. php:const:: NO_INDENT

   This class constant wasn't indented

.. php:staticmethod:: OtherClass::staticMethod()

   A static method.


Exceptions
==========

.. php:exception:: InvalidArgumentException

   Throw when you get an argument that is bad.


Interfaces
==========

.. php:interface:: DateTimeInterface

   Datetime interface

   .. php:method:: setDate($year, $month, $day)

      Set the date in the datetime object

      :param int $year: The year.
      :param int $month: The month.
      :param int $day: The day.

   .. php:method:: setTime($hour, $minute[, $second])

      Set the time

      :param int $hour: The hour
      :param int $minute: The minute
      :param int $second: The second

   .. php:const:: ATOM

      Y-m-d\TH:i:sP

   .. php:attr:: testattr

      Value of some attribute

.. php:interface:: OtherInterface

   Another interface


Traits
======

.. php:trait:: LogTrait

   A logging trait

   .. php:method:: log($level, $string)

      A method description.


More globals after classes
==========================

.. php:global:: $other_global_var

   A global variable

.. php:global:: strpos($needle, $haystack)

   Position of needle in haystack


Test Case - Global symbols with no namespaces
---------------------------------------------

:php:global:`$global_var`

:php:global:`$other_global_var`

:php:const:`SOME_CONSTANT`

:php:func:`in_array`

:php:func:`strpos`

:php:class:`DateTime`

:php:func:`DateTime::setTime()`

:php:func:`DateTime::getLastErrors()`

:php:func:`~DateTime::setDate()`

:php:func:`DateTime::ATOM`

:php:func:`DateTime::$testattr`

:php:func:`OtherClass::update`

:php:attr:`OtherClass::$nonIndentedAttribute`

:php:const:`OtherClass::NO_INDENT`

:php:func:`OtherClass::staticMethod`

:php:exc:`InvalidArgumentException`

:php:interface:`DateTimeInterface`

:php:func:`DateTimeInterface::setTime()`

:php:func:`~DateTimeInterface::setDate()`

:php:func:`DateTimeInterface::ATOM`

:php:func:`DateTimeInterface::$testattr`

:php:func:`OtherInterface`

:php:trait:`LogTrait`

:php:func:`LogTrait::log()`

.. php:namespace:: LibraryName


Namespaced elements
===================

.. php:function:: namespaced_function($one[, $two])

   A function in a namespace

   :param string $one: First parameter.
   :param string $two: Second parameter.

.. php:const:: NS_CONST

      A constant in a namespace


.. php:exception:: NamespaceException

   This exception is in a namespace.


.. php:class:: LibraryClass

   A class in a namespace

   .. php:method:: LibraryClass::instanceMethod($foo)

      An instance method

   .. php:const:: TEST_CONST

      Test constant

   .. php:attr:: property

      A property!

.. php:staticmethod:: LibraryClass::staticMethod()

   A static method in a namespace

.. php:class:: NamespaceClass

   A class in the namespace, no indenting on children

.. php:method:: firstMethod($one, $two)

   A normal instance method.

.. php:attr:: property

   A property

.. php:const:: NAMESPACE_CONST

   Const on class in namespace

.. php:staticmethod:: namespaceStatic($foo)

   A static method here.

.. php:class:: final LibraryClassFinal

   A final class

.. php:method:: public firstMethod($one, $two)

   A public instance method.

.. php:method:: protected secondMethod($one, $two)

   A protected instance method.

.. php:method:: private thirdMethod($one, $two)

   A private instance method.

.. php:method:: static fourthMethod($one, $two)

   A static method.

.. php:method:: protected final fifthMethod($one, $two)

   A protected final method.

.. php:class:: abstract LibraryClassAbstract

   An abstract class

.. php:interface:: LibraryInterface

   A interface in a namespace

   .. php:method:: instanceMethod($foo)

   An instance method

.. php:trait:: TemplateTrait

   A trait in a namespace

   .. php:method:: render($template)

   Render a template.


Test Case - not including namespace
-----------------------------------

:php:ns:`LibraryName`

:php:func:`namespaced_function()`

:php:const:`NS_CONST`

:php:class:`LibraryClass`


:php:class:`~LibraryName\\LibraryClass`

:php:func:`LibraryClass::instanceMethod`

:php:func:`LibraryClass::staticMethod()`

:php:attr:`LibraryClass::$property`

:php:const:`LibraryClass::TEST_CONST`

:php:class:`LibraryName\\OtherClass`

:php:class:`LibraryName\\ThirdClass`

:php:class:`NamespaceClass`

:php:func:`NamespaceClass::firstMethod`

:php:attr:`NamespaceClass::$property`

:php:const:`NamespaceClass::NAMESPACE_CONST`

:php:class:`LibraryClassFinal`

:php:meth:`LibraryClassFinal::firstMethod`

:php:meth:`LibraryClassFinal::secondMethod`

:php:meth:`LibraryClassFinal::thirdMethod`

:php:meth:`LibraryClassFinal::fourthMethod`

:php:meth:`LibraryClassFinal::fifthMethod`

:php:interface:`LibraryInterface`

:php:interface:`~LibraryName\\LibraryInterface`

:php:func:`LibraryInterface::instanceMethod`

:php:exc:`NamespaceException`

:php:trait:`TemplateTrait`

:php:trait:`LibraryName\\TemplateTrait`

:php:func:`LibraryName\\TemplateTrait::render()`

Test Case - global access
-------------------------

:php:class:`DateTime`

:php:func:`DateTime::setTime()`

:php:global:`$global_var`

:php:const:`SOME_CONSTANT`

:php:attr:`LibraryName\\LibraryClass::$property`

:php:const:`LibraryName\\LibraryClass::TEST_CONST`

:php:const:`LibraryName\\NS_CONST`

:php:interface:`DateTimeInterface`

:php:func:`DateTimeInterface::setTime()`


Any Cross Ref
=============

:any:`LibraryName\\SubPackage\\NestedNamespaceException`

:any:`DateTimeInterface::$testattr`



Nested namespaces
=================

.. php:namespace:: LibraryName\SubPackage

.. php:exception:: NestedNamespaceException

   In a package

.. php:class:: SubpackageClass

   A class in a subpackage

.. php:interface:: SubpackageInterface

   A class in a subpackage

Test Case - Test subpackage links
---------------------------------

:php:ns:`LibraryName\\SubPackage`

:php:class:`SubpackageClass`

:php:class:`LibraryName\\SubPackage\\SubpackageClass`

:php:interface:`SubpackageInterface`

:php:class:`LibraryName\\SubPackage\\SubpackageInterface`

:php:exc:`LibraryName\\SubPackage\\NestedNamespaceException`


Return Types
============

.. php:namespace:: OtherLibrary

.. php:class:: ReturningClass

   A class to do some returning.

   .. php:method:: returnClassFromSameNamespace()

      :returns: An object instance of a class from the same namespace.
      :returntype: OtherLibrary\\ReturnedClass

   .. php:method:: returnClassFromOtherNamespace()

      :returns: An object instance of a class from another namespace.
      :returntype: LibraryName\\SubPackage\\SubpackageInterface

   .. php:method:: returnClassConstant()

      :returns: The value of a specific class constant.
      :returntype: LibraryName\\NamespaceClass::NAMESPACE_CONST

   .. php:method:: returnGlobalConstant()

      :returns: The value of a specific global constant.
      :returntype: SOME_CONSTANT

   .. php:method:: returnExceptionInstance()

      :returns: An instance of an exception.
      :returntype: InvalidArgumentException

   .. php:method:: returnScalarType()

      :returns: A scalar string type.
      :returntype: string

   .. php:method:: returnUnionType()

      :returns: Any of a whole bunch of things specified with a PHP 8 union type.
      :returntype: int|string|OtherLibrary\\ReturnedClass|LibraryName\\SubPackage\\SubpackageInterface|null

.. php:class:: ReturnedClass

   A class to return.



Top Level Namespace
-------------------

Credit: The source for this section was taken from the original `GitHub
repository markstory/sphinxcontrib-phpdomain
<https://github.com/markstory/sphinxcontrib-phpdomain>`__.


namespace ``Imagine\Draw``

.. php:namespace:: Imagine\Draw

.. php:class:: DrawerInterface

Instance of this interface is returned by :php:meth:`Imagine\Image\ImageInterface::draw`.

.. php:method:: arc(PointInterface $center, BoxInterface $size, $start, $end, Color $color)

   Draws an arc on a starting at a given x, y coordinates under a given start and end angles

   :param Imagine\Image\PointInterface $center: Center of the arc.
   :param Imagine\Image\BoxInterface $size: Size of the bounding box.
   :param integer $start: Start angle.
   :param integer $end: End angle.
   :param Imagine\Image\Color $color: Line color.

   :throws: Imagine\Exception\RuntimeException

   :returns: Imagine\Draw\DrawerInterface

Re-used namespace
=================

.. php:currentmodule:: LibraryName

No indexing errors or links should point to this namespace.

.. php:class:: ThirdClass

   Another class in a currentmodule block

.. php:currentnamespace:: LibraryName

No indexing errors or links should point to this namespace.

.. php:class:: OtherClass

   Another class in a reused namespace