xplo.re Medusa Core Framework 3.1
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • Requirement

Class Requirement

Base class for dependency requirement implementations.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Module\Dependency\Requirement

Direct known subclasses

Core\Module\Dependency\Requirement\Core\sspi_auth, Core\Module\Dependency\Requirement\PHP, Core\Module\Dependency\Requirement\PHP\mbstring, Core\Module\Dependency\Requirement\PHP\mysqli, Core\Module\Dependency\Requirement\PHP\openssl, Core\Module\Dependency\Requirement\PHP\pcre, Core\Module\Dependency\Requirement\PHP\session, Core\Module\Dependency\Requirement\PHP\SimpleXML, Core\Module\Dependency\Requirement\PHP\SPL, Core\Module\Dependency\Requirement\PHP\SQLite, Core\Module\Dependency\Requirement\PHP\sqlite3, Core\Module\Dependency\Requirement\PHP\zlib, Core\Module\Dependency\Requirement\PHP\bcmath, Core\Module\Dependency\Requirement\PHP\bz2, Core\Module\Dependency\Requirement\PHP\date, Core\Module\Dependency\Requirement\PHP\ereg, Core\Module\Dependency\Requirement\PHP\gd, Core\Module\Dependency\Requirement\PHP\hash, Core\Module\Dependency\Requirement\PHP\ldap, Core\Module\Dependency\Requirement\PHP\libxml

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

Methods summary

public static Core\Module\Dependency\Requirement
# autocreate( string $moduleName )

Requirement factory.

Requirement factory.

Parameters

$moduleName
Name of requirement module.

Returns

Core\Module\Dependency\Requirement

Since

3.1
abstract public boolean
# load( )

Loads the extension.

Loads the extension.

Returns

boolean
true, if the extension was successfully loaded, otherwise false.

Since

3.1
public boolean
# verifyLoad( SimpleXMLElement $node, string & $reason )

Specialised verification method to test, whether a dependency is available.

Specialised verification method to test, whether a dependency is available.

This test is always executed if a requirement is set regardless of the number of additional defined tests; if this test fails, no other tests are executed. Hence, if this test succeeds, a requirement must ensure that all other tests can be executed.

Parameters

$node
Requirement node on the XML dependency block tree.
$reason
Variable reference to store the reason on failure.

Returns

boolean

true, if the dependency is available and further tests may be conducted, otherwise false.

Since

3.1
public boolean
# verifyMaxVersion( mixed $maxVersion, string & $reason )

Tests, whether the requirement meets the maximum supported version.

Tests, whether the requirement meets the maximum supported version.

Parameters

$maxVersion
Maximum version number that is supported.
$reason
Variable reference to store the reason on failure.

Returns

boolean
true, if the maximum version dependency is met, otherwise false.

Since

3.1
public boolean
# verifyMinVersion( mixed $minVersion, string & $reason )

Tests, whether the requirement meets the minimum supported version.

Tests, whether the requirement meets the minimum supported version.

Parameters

$minVersion
Minimum version number that is supported.
$reason
Variable reference to store the reason on failure.

Returns

boolean
true, if the minimum version dependency is met, otherwise false.

Since

3.1
abstract public mixed
# version( )

Returns the available extension module version of the runtime environment.

Returns the available extension module version of the runtime environment.

Returns

mixed
Version number of extension.

Remark

Requirement implementations should either return a Core\Version instance or a version number string. Other values are automatically converted to a string during comparisons.


Since

3.1
public string
# warning( )

Requirement usage warning, i.e. extension is deprecated or the current version is known to have bugs.

Requirement usage warning, i.e. extension is deprecated or the current version is known to have bugs.

Returns

string

Warning message as a string. For standard warnings, the corresponding constants are returned. Multiple warnings are separated by a newline (LF) character. Returns null if there are no warnings.

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 DeprecatedWarning

Deprecated extension warning message.

Deprecated extension warning message.

Since

3.1
# 'This extension has been marked as deprecated and should not be used.'
string ObsoleteWarning

Obsolete extension warning message.

Obsolete extension warning message.

Since

3.1
# 'This extension has been marked as obsolete and must not be used.'

Constants inherited from Core\Object

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

Properties summary

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.1 API documentation generated by ApiGen