model/modx/modpluginevent.class.php

package: modx
Classes: modPluginEvent

Description

Represents a plugin registered for a specific event.

\modPluginEvent
jump to top

Extends from: \xPDOObject
package: modx
Methods: remove; save

Description

Represents a plugin registered for a specific event.

This is the basis for the entire xPDO object model, and can also be used by a class generator {@link xPDOGenerator}, ultimately allowing custom classes to be user-defined in a web interface and framework-generated at runtime.

Methods

remove
jump to class

remove(
          array $ancestors
              =
              array
          )
        
        :
        boolean

Overrides xPDOObject::remove to fire modX-specific events.

{@inheritDoc}

Arguments

$ancestors: array
Keeps track of classes which have already been removed to prevent loop with circular references.

Output

boolean: Returns true on success, false on failure.

Details

visibility: public
final: false
static: false

save
jump to class

save(
          boolean|integer $cacheFlag
              =
              null
          )
        
        :
        boolean

Overrides xPDOObject::save to fire modX-specific events.

{@inheritDoc}

Arguments

$cacheFlag: booleaninteger
Indicates if the saved object(s) should be cached and optionally, by specifying an integer value, for how many seconds before expiring. Overrides the cacheFlag for the object(s).

Output

boolean: Returns true on success, false on failure.

Details

visibility: public
final: false
static: false

model/modx/modpluginevent.class.php

Description

\modPluginEventjump to top

Description

Methods

removejump to class

Arguments

Output

Details

savejump to class

Arguments

Output

Details

\modPluginEvent
jump to top

remove
jump to class

save
jump to class