API Documentation
\

\Ingo_Factory_Script

A Horde_Injector based Ingo_Script factory.

Summary

Methods
Properties
Constants
create()
createAll()
hasFeature()
perform()
canPerform()
activateAll()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

create()

create(integer  $rule) : \Ingo_Script

Returns a Ingo_Script instance.

Parameters

integer $rule

A script rule, one of the Ingo::RULE_* constants.

Throws

\Ingo_Exception

Returns

\Ingo_Script —

A Ingo_Script instance.

createAll()

createAll() : array

Returns all Ingo_Script instances.

Throws

\Ingo_Exception

Returns

array —

All Ingo_Script instances.

hasFeature()

hasFeature(string  $feature) : boolean

Returns whether the script drivers support a certain feature.

Parameters

string $feature

A feature name.

Returns

boolean —

True if this feature is supported.

perform()

perform(integer  $change = null)

Performs the filtering specified in all rules.

Parameters

integer $change

The timestamp of the latest rule change during the current session.

canPerform()

canPerform() : boolean

Is the perform() function available?

Returns

boolean —

True if perform() is available, false if not.

activateAll()

activateAll(boolean  $auto_update = true)

Activate all scripts.

Parameters

boolean $auto_update

Only update if auto_update is active?