Requirement

Type
Class
Namespace
Craft
Inherits
Craft\Requirement » CComponent
Extended by
Craft\IconvRequirement, Craft\McryptRequirement, Craft\PhpVersionRequirement, Craft\WebRootExposedFolderRequirement

Requirement class.

View source

Public Methods

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

__construct()

Constructor

View source

Arguments

Returns

Craft\Requirement

Signature

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

getName()

View source

Returns

mixed

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

MethodDescription
calculateResult()Calculates the result of this requirement.

calculateResult()

Calculates the result of this requirement.

View source

Returns

string

Signature

protected string calculateResult ( )