Documentation

Ingo_Factory_Script extends Horde_Core_Factory_Base
in package

A Horde_Injector based Ingo_Script factory.

Tags
author

Michael Slusarz slusarz@horde.org

author

Jan Schneider jan@horde.org

category

Horde

license

http://www.horde.org/licenses/apache ASL

Table of Contents

activateAll()  : mixed
Activate all scripts.
canPerform()  : bool
Is the perform() function available?
create()  : Ingo_Script
Returns a Ingo_Script instance.
createAll()  : array<string|int, mixed>
Returns all Ingo_Script instances.
hasFeature()  : bool
Returns whether the script drivers support a certain feature.
perform()  : mixed
Performs the filtering specified in all rules.

Methods

activateAll()

Activate all scripts.

public activateAll([bool $auto_update = true ]) : mixed
Parameters
$auto_update : bool = true

Only update if auto_update is active?

Return values
mixed

canPerform()

Is the perform() function available?

public canPerform() : bool
Return values
bool

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

create()

Returns a Ingo_Script instance.

public create(int $rule) : Ingo_Script
Parameters
$rule : int

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

Tags
throws
Ingo_Exception
Return values
Ingo_Script

A Ingo_Script instance.

createAll()

Returns all Ingo_Script instances.

public createAll() : array<string|int, mixed>
Tags
throws
Ingo_Exception
Return values
array<string|int, mixed>

All Ingo_Script instances.

hasFeature()

Returns whether the script drivers support a certain feature.

public hasFeature(string $feature) : bool
Parameters
$feature : string

A feature name.

Tags
see
Ingo_Script_Base::hasFeature()
Return values
bool

True if this feature is supported.

perform()

Performs the filtering specified in all rules.

public perform([int $change = null ]) : mixed
Parameters
$change : int = null

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

Return values
mixed

Search results