Common
[ class tree: Common ] [ index: Common ] [ all elements ]

Class: PluginBase

Source Location: /common/PluginBase.php

Class Overview


Base class for plugins


Author(s):

Variables

Methods


Child classes:

ClientPlugin
Client plugin
ServerPlugin
Server plugin

Class Details

[line 28]
Base class for plugins



Tags:

abstract:  


[ Top ]


Class Variables

$basePath =

[line 39]

Root path for plugin files



Tags:

access:  private

Type:   string


[ Top ]

$log =

[line 33]



Tags:

access:  private

Type:   Logger


[ Top ]

$name =

[line 44]



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 49]


method getBasePath [line 65]

string getBasePath( )



Tags:

access:  public


[ Top ]

method getExtendedName [line 102]

string getExtendedName( )



Tags:

access:  public


[ Top ]

method getName [line 88]

string getName( )



Tags:

access:  public


[ Top ]

method getRequest [line 118]

mixed getRequest( boolean $isRequest, mixed $mapRequest)

Get plugin's request or result out of MapRequest or MapResult

The name of the request|result field is selected according to this current plugin name (see getName()). Although this is called getRequest, it is not tied to a request. Unserialization is done globally (not for each plugin).




Tags:

return:  mapRequest|Result or NULL if no such request|result
access:  public


Parameters:

boolean   $isRequest   true if a mapRequest, false if mapResult
mixed   $mapRequest   mapRequest or mapResult

[ Top ]

method initialize [line 144]

void initialize( )

Plugin initialization (can be extended in custom plugins)



Tags:

access:  public


Overridden in child classes as:

ClientAuth::initialize()
ClientProjectTableRules::initialize()
ServerProjectTableRules::initialize()

[ Top ]

method initializeConfig [line 60]

void initializeConfig( mixed $initArgs)

Initializes plugin

Internal call, use PluginBase::initialize() to extend initialization in custom plugins.




Tags:

access:  public
abstract:  


Overridden in child classes as:

ClientPlugin::initializeConfig()
Initializes plugin configuration
ServerPlugin::initializeConfig()
Initializes plugin configuration

Parameters:

mixed   $initArgs  

[ Top ]

method replacePlugin [line 137]

string replacePlugin( )

Returns name of parent plugin in case of plugin extension

Must be overridden in child plugin class




Tags:

access:  public


Overridden in child classes as:

ClientProjectImages::replacePlugin()
ClientProjectLocation::replacePlugin()
ServerProjectLocation::replacePlugin()

[ Top ]

method setBasePath [line 74]

void setBasePath( string $basePath)



Tags:

access:  public


Parameters:

string   $basePath  

[ Top ]

method setExtendedName [line 95]

void setExtendedName( string $extendedName)



Tags:

access:  public


Parameters:

string   $extendedName  

[ Top ]

method setName [line 81]

void setName( string $name)



Tags:

access:  public


Parameters:

string   $name  

[ Top ]


Documentation generated on Wed, 6 Apr 2005 12:06:50 +0200 by phpDocumentor 1.3.0RC3