lithium\analysis\Inspector::properties()

public static method

Returns various information on the properties of an object.

Parameters

string|object $class
A string class name for purely static classes or an object instance, from which to get properties.
array $options
Set of options applied directly (check _items() for more options):
- 'properties': array of properties to gather information from.
- 'self': If true (default), only returns properties defined in $class, excluding properties from inherited classes.

Returns

mixed

Returns an array with information about the properties from the class given in $class or null on error.

Source

	public static function properties($class, array $options = []) {
		$defaults = ['properties' => [], 'self' => true];
		$options += $defaults;

		try {
			$reflClass = new ReflectionClass($class);
		} catch (ReflectionException $e) {
			return null;
		}
		$options += ['names' => $options['properties']];

		return static::_items($reflClass, 'getProperties', $options)->map(function($item) use ($class) {
			$modifiers = array_values(Inspector::invokeMethod('_modifiers', [$item]));
			$setAccess = (
				array_intersect($modifiers, ['private', 'protected']) !== []
			);
			if ($setAccess) {
				$item->setAccessible(true);
			}
			if (is_string($class)) {
				if (!$item->isStatic()) {
					$message = 'Must provide an object instance for non-static properties.';
					throw new InvalidArgumentException($message);
				}
				$value = $item->getValue($item->getDeclaringClass());
			} else {
				$value = $item->getValue($class);
			}
			$result = compact('modifiers', 'value') + [
				'docComment' => $item->getDocComment(),
				'name' => $item->getName()
			];
			if ($setAccess) {
				$item->setAccessible(false);
			}
			return $result;
		}, ['collect' => false]);
	}