sphinx-contrib / phpdomain /

Filename Size Date modified Message
..
doc
sphinxcontrib
test
620 B
1.4 KB
47 B
2.4 KB
79 B
1.1 KB
PHP Domain
##########

:author: Mark Story <mark at mark-story.com>

About
=====

A domain for sphinx >= 1.0 that provides language support for PHP.

PHP Domain supports following objects:

* Global variable
* Global function
* Constant
* Namespace

  * Function
  * Class

* Class

  * Class constant
  * Instance methods
  * Static methods
  * Properties

.. note::

   This domain expresses methods and attribute names like this::

      Class::method_name
      Class::$attribute_name

   You address classes/functions in namespaces using \\ syntax as you would in PHP::

        Package\Subpackage\Class

URLs
====

:PyPI: http://pypi.python.org/pypi/sphinxcontrib-phpdomain
:Detail Document: http://packages.python.org/sphinxcontrib-phpdomain

Quick Sample
============

This is source::

  .. 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

Result
-----------------

.. 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

Cross referencing
-----------------

From other place, you can create cross reference like that::

   You can modify a DateTime's date using :php:meth:`DateTime::setDate`.

Result
-----------

You can modify a DateTime's date using :php:meth:`DateTime::setDate`.

Install
=======

You can install the phpdomain using easy_install::

   easy_install -U sphinxcontrib-phpdomain

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.