WireApiDocs::getConstants()

Get public constants for given class

Returns an array of arrays, each with these keys:

  • name (string): Constant name
  • value (mixed): Constant value
  • description (string): Description from phpdoc docblock (may be empty)

Only constants declared on the class itself are included (not inherited). Non-public constants are excluded.

Usage

$array = $wireApiDocs->getConstants(string $class);

Arguments

NameType(s)Description
$classstring

Class name (with or without ProcessWire namespace)

Return value

array

WireApiDocs methods and properties

API reference based on ProcessWire core version 3.0.267