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

Class: ViewUpgrader

Source Location: /client/Views.php

Class Overview


Basis of views upgrade filters


Author(s):

Variables

Methods


Child classes:

OutlineV1ToV2
Upgrades from V1 to V2
OutlineV2ToV3
Upgrades from V2 to V3

Class Details

[line 1730]
Basis of views upgrade filters

This class must be extended to define plugin view data filters. Extended classes must be stored in <plugin>/client/ViewsUpgrade.php and named for instance MyPluginV34ToV35. Each filter must be design to upgrade view data from given version N to version N+1.

This class provides generic filtering methods




Tags:

abstract:  


[ Top ]


Class Variables

$storage =

[line 1735]



Tags:

access:  protected

Type:   stdClass


[ Top ]



Class Methods


method add [line 1771]

void add( string $to, mixed $value)

Adds a new property.



Tags:

access:  protected


Parameters:

string   $to   new property name
mixed   $value   value of new property

[ Top ]

method callFilters [line 1756]

void callFilters( )

Executes upgrade filters. To be redefined in extended filters.



Tags:

access:  protected
abstract:  


Overridden in child classes as:

OutlineV1ToV2::callFilters()
OutlineV2ToV3::callFilters()

[ Top ]

method remove [line 1762]

void remove( string $from)

Removes given property.



Tags:

access:  protected


Parameters:

string   $from   property name

[ Top ]

method rename [line 1784]

void rename( string $from, string $to)

Updates name of property.



Tags:

access:  protected


Parameters:

string   $from   old name
string   $to   new name

[ Top ]

method upgrade [line 1742]

bool upgrade( stdclass &$storage)

Upgrades given plugin storage.



Tags:

return:  true if success
access:  public


Parameters:

stdclass   &$storage   plugin storage to upgrade

[ Top ]


Documentation generated on Mon, 13 Feb 2006 11:44:20 +0100 by phpDocumentor 1.3.0RC3