Requirement

Type
Class
Namespace
Craft
Inherits
Craft\Requirement » CComponent (opens new window)
Extended by
Craft\IconvRequirement, Craft\McryptRequirement, Craft\PhpVersionRequirement, Craft\WebRootExposedFolderRequirement

Requirement class.

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() Constructor
__get() (opens new window) Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window) Checks if a property value is null.
__set() (opens new window) Sets value of a component property.
__unset() (opens new window) Sets a component property to be null.
asa() (opens new window) Returns the named behavior object.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
attachEventHandler() (opens new window) Attaches an event handler to an event.
canGetProperty() (opens new window) Determines whether a property can be read.
canSetProperty() (opens new window) Determines whether a property can be set.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
detachEventHandler() (opens new window) Detaches an existing event handler.
disableBehavior() (opens new window) Disables an attached behavior.
disableBehaviors() (opens new window) Disables all behaviors attached to this component.
enableBehavior() (opens new window) Enables an attached behavior.
enableBehaviors() (opens new window) Enables all behaviors attached to this component.
evaluateExpression() (opens new window) Evaluates a PHP expression or callback under the context of this component.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
getName()
getNotes()
getRequired()
getRequiredBy()
getResult()
hasEvent() (opens new window) Determines whether an event is defined.
hasEventHandler() (opens new window) Checks whether the named event has attached handlers.
hasProperty() (opens new window) Determines whether a property is defined.
raiseEvent() (opens new window) Raises an event.

# __construct()

Signature

public Craft\Requirement __construct ( $name = null, $condition = null, $required = true, $requiredBy = null, $notes = null )

# getName()

Signature

public mixed getName ( )

# getNotes()

Signature

public null getNotes ( )

# getRequired()

Signature

public boolean getRequired ( )

# getRequiredBy()

Signature

public null getRequiredBy ( )

# getResult()

Signature

public string getResult ( )

# Protected Methods

Method Description
calculateResult() Calculates the result of this requirement.

# calculateResult()

Calculates the result of this requirement.

View source (opens new window)

Returns

string (opens new window)

Signature

protected string calculateResult ( )