About the Documentation

Documentation status

While there is a lot of useful information in these pages, this documentation is far from finished. If you run across any issues, please create an issue on GitHub describing the problem or submit a pull request. Pages may be deleted or moved without notice until the documentation is more complete.

Syntax and conventions

This documentation uses several conventions to help explain concepts and document APIs.

Italic and bold type face are used to provide emphasis, as you might expect.

Monospace text is used for class names, function names, and variable names. It is also used for text that should be typed verbatim in the terminal.

Pay special attention to different types of notes as well.

Note

This is a note. Notes contain supplementary information set apart from the text.

Tip

This is a tip. Tips offer helpful advice on how something can be used or on best practices.

Warning

This is a warning. Warnings help you avoid annoying problems or unexpected behavior.

Prototypes for object instance methods are described in this documentation using the following syntax:

ClassOrInterfaceName::methodName(ArgumentType $arg = 'default-value'): ReturnType

Prototypes for static object methods are described in this documentation using the following syntax:

static ClassOrInterfaceName::methodName(ArgumentType $arg = 'default-value'): ReturnType

Prototypes for functions in a namespace are described in this documentation using the following syntax:

Namespace\functionName(ArgumentType $arg = 'default-value'): ReturnType

To document the expected prototype of a callback function used as method arguments or return types, this documentation uses the following syntax for callable types:

callable(ArgumentType $arg): ReturnType

Documentation for methods inherited from a parent class or implementing an interface are not re-documented unless there is a significant difference in behavior.

Next: Installing