Class Module

Represents Core-compatible modules and provides an advanced query interface.

Core\Object implements Core\Chainable

Core\Set implements Core\Accessor

Core\Module

Namespace: Core
Package: Core\Module
Since: 3.1
Requires: PHP 5.3
Version: 1.1
Located at Module.inc.php

Methods summary

`public`	# `__construct( string $module )` Initialises a new instance from a module name. The constructor does not test, whether the module actually exists; this enables the use of some interface methods for non-existent modules. Use exists() to test whether the represented module is actually found in the search paths. Initialises a new instance from a module name. The constructor does not test, whether the module actually exists; this enables the use of some interface methods for non-existent modules. Use exists() to test whether the represented module is actually found in the search paths. Parameters `$module` Module name with full namespace specification. Since 3.1
`public static Core\Module`	# `createWithRegisteredFilename( string $filename )` Creates a new module instance from filename registered with the Loader. Creates a new module instance from filename registered with the Loader. Parameters `$filename` Filename to retrieve module for. Returns `Core\Module` Module instance if filename is pointing to an existing module, otherwise `null`. Since 3.1
`public Core\Module\Dependency\|false`	# `dependencies( )` Returns a new `Core\Module\Dependency` instance for the represented module. Returns a new `Core\Module\Dependency` instance for the represented module. Returns `Core\Module\Dependency`\|false New dependency information instance, `false`, if the module does not exist or `null`, if it does not contain valid dependency information. Since 3.1
`public boolean`	# `exists( )` Determines whether the represented module exists. Determines whether the represented module exists. Returns boolean `true`, if the represented module actually exists, otherwise `false`. Since 3.1
`public true`	# `load( )` Loads the represented module by using the standard Loader interface. Loads the represented module by using the standard Loader interface. Returns true `true` on success, otherwise an exception is thrown. Since 3.1
`public string\|false`	# `realPath( )` Returns the canonicalised absolute filename of the represented module. Returns the canonicalised absolute filename of the represented module. Returns string\|false Fully canonicalised absolute filename of the represented module or `false` on failure, e.g. if the module file does not exist. Since 3.1
`public static Core\Module_Iterator`	# `recursiveIteratorForPath( string $path )` Returns a new module iterator instance to recursively list modules. Returns a new module iterator instance to recursively list modules. Parameters `$path` Pathname to start module recursion in. Returns `Core\Module_Iterator` Module iterator instance to iterator over modules found. Since 3.1
`public Core\Version`	# `version( )` Returns the module version. Returns the module version. Returns `Core\Version` Version information instance or `null`, if no version information is available. Since 3.1 \todo Currently only implemented for already loaded modules.

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

Constants inherited from Core\Object

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

Properties summary

`protected string`	`$_v_filename` Module filename. Module filename. Since 3.1	#
`protected string`	`$_v_name` Name of module. Name of module. Since 3.1	#
`protected string`	`$_v_resolvedPath` Fully resolved module filename. Fully resolved module filename. Since 3.1	#

Magic properties

`public read-only Core\Module\Dependency\|false`	`$dependencies` See `Core\Module::dependencies()`.
`public read-only boolean`	`$exists` `true`, if the represented module actually exists, otherwise `false`.
`public read-only string`	`$filename` Module filename.
`public read-only string`	`$name` Name of module.
`public read-only string`	`$realPath` Canonicalised absolute filename of the module.
`public read-only string`	`$resolvedPath` Fully resolved module filename.
`public read-only Core\Version`	`$version` Version information instance or `null`, if no version information is available.

Magic properties inherited from Core\Object

$hash, $uuid

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class Module

Methods summary

Parameters

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Methods inherited from Core\Set

Methods inherited from Core\Object

Constants summary

Constants inherited from Core\Object

Properties summary

Since

Since

Since

Magic properties

Magic properties inherited from Core\Object