WireApiDocs::getVerbose()

Same as get() method but with verbose array return value

Return value is always an array of arrays, indexed by class name. Each array includes:

  • className (string): Name of class
  • classFile (string): Full path to class file
  • apiVarName (string): API variable name (blank if not applicable)
  • isModule (bool): Is this a module?
  • docsFile (string): Full path to API.md docs file
  • docs (string): Contents of API.md docs file in markdown format

If getting all classes or using wildcards, the full docs key is replaced with summary, which is just the first paragraph of the docs:

  • summary (string): Brief bummary header from API.md

Usage

// basic usage
$array = $wireApiDocs->getVerbose();

// usage with all arguments
$array = $wireApiDocs->getVerbose($get = [], array $options = []);

Arguments

NameType(s)Description
$get (optional)array string
$options (optional)array
  • exclude (array): Names of properties to exclude from the result
  • rename (array): Mapping of property names to new names
  • indexByClass (bool): Index by class name? Specify false for plain PHP array Default:true

Return value

array

WireApiDocs methods and properties

API reference based on ProcessWire core version 3.0.264