Class Dependency

Extracts and verifies dependency information from modules.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Module\Dependency

Namespace: Core\Module
Package: Core\Module
Since: 3.1
Requires: PHP 5.3, SimpleXML
Version: 1.0
Located at Module/Dependency.inc.php

Methods summary

`public`	# `__construct( string\|Core\Module\|Core\Stream $module )` Initialised a new dependency information instance from module data. Initialised a new dependency information instance from module data. Parameters `$module` Module name (with full namespace specification in standardised form), Module instance, module filename or data stream to extract dependency information block from. Throws `Core\Exception\InvalidArgument` The supplied data source does not contain a dependency information data block. `Core\Exception\UnexpectedValue` The extracted dependency information data block does not contain valid XML data; the exception message contains a detailed report on the XML parser errors found. Since 3.1
`public static string`	# `extractInfoBlockFromStream( Core\Stream $ifs )` Parses input stream data and extracts the dependency info block, if any. Parses input stream data and extracts the dependency info block, if any. Parameters `$ifs` Stream instance in established read mode to extract dependency information block from. Returns string Dependency information block extracted from data stream or `null` on error. Remark If multiple dependency information blocks are present, the first block, starting from the current stream position, is extracted and returned. \n Dependency information blocks based on an unknown XML namespace will be ignored. See `Core\Module\Dependency::XMLNS` Since 3.1
`public boolean`	# `verify( array & $report = null, array $classes = null )` Tests dependencies of module classes. Tests dependencies of module classes. Parameters `$report` Associative output array of class names as keys with dependency verification results as values. `$classes` Array of module class names to verify dependency for. Defaults to all classes of the module. Returns boolean `true`, if all tests succeeded, otherwise `false`. Since 3.1

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

`string`	`XMLNS` XML namespace for dependency specifications. XML namespace for dependency specifications. Since 3.1	# `'http://xmlns.xplo-re.net/core/dependencies/1.0'`

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

`protected array`	`$_v_classes` Array of classes from module dependency information. Array of classes from module dependency information. Since 3.1	#
`protected SimpleXMLElement`	`$_v_moduleNode` Dependency information node for module. Dependency information node for module. Since 3.1	#
`protected static Core\Module\Dependency\Requirement[]`	`$_requirements` Global buffer of dependency requirement instances. Global buffer of dependency requirement instances. Since 3.1	#

Magic properties

`public read-only array`	`$classes` Array of classes in module dependency information.
`public read-only SimpleXMLElement`	`$moduleNode` Dependency information node for module.

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Class Dependency

Methods summary

Parameters

Throws

Since

Parameters

Returns

Remark

See

Since

Parameters

Returns

Since

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Since

Constants inherited from Core\Object

Properties summary

Since

Since

Since

Magic properties

Magic properties inherited from Core\Object