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

Class: ViewContainer

Source Location: /client/Views.php

Class Overview


Views recording/loading.


Author(s):

Variables

Constants

Methods


Child classes:

ViewFileContainer
Views recording/loading to/from file.
ViewDbContainer
Views recording/loading to/from database.

Class Details

[line 786]
Views recording/loading.



Tags:

abstract:  


[ Top ]


Class Variables

$action =

[line 796]



Tags:

access:  protected

Type:   string


[ Top ]

$catalog =

[line 821]



Tags:

access:  protected

Type:   array


[ Top ]

$data =

[line 811]



Tags:

access:  protected

Type:   array


[ Top ]

$isActionSuccess =

[line 831]



Tags:

access:  protected

Type:   boolean


[ Top ]

$locationId =  0

[line 841]



Tags:

access:  protected

Type:   int


[ Top ]

$log =

[line 791]



Tags:

access:  protected

Type:   Logger


[ Top ]

$message =

[line 806]



Tags:

access:  protected

Type:   string


[ Top ]

$metas =

[line 816]



Tags:

access:  protected

Type:   array


[ Top ]

$viewId =

[line 801]



Tags:

access:  protected

Type:   int


[ Top ]

$weight =

[line 836]



Tags:

access:  protected

Type:   int


[ Top ]

$writeActions = array('insert', 'update', 'delete')

[line 826]



Tags:

access:  protected

Type:   array


[ Top ]



Class Methods


constructor __construct [line 848]

ViewContainer __construct( )

Constructor



Tags:

access:  public


Overridden in child classes as:

ViewFileContainer::__construct()
Constructor
ViewDbContainer::__construct()
Constructor

[ Top ]

method closeResource [line 860]

void closeResource( )

Closes connection to storage resource.



Tags:

access:  protected
abstract:  


Overridden in child classes as:

ViewFileContainer::closeResource()
Closes view-storage file.
ViewDbContainer::closeResource()

[ Top ]

method computeLocationId [line 1114]

int computeLocationId( )

Returns ID of view located right after current view.



Tags:

access:  private


[ Top ]

method computeWeight [line 1061]

void computeWeight( )

Computes weight of current view to determine its location in the views list.



Tags:

access:  private


[ Top ]

method delete [line 999]

void delete( int $viewId)

Wrapper for 'delete' action.



Tags:

access:  public


Overridden in child classes as:

ViewFileContainer::delete()
Deletes given view.

Parameters:

int   $viewId   view ID

[ Top ]

method doAction [line 902]

boolean doAction( string $action)

Performs view processing.



Tags:

return:  if true, action succeeded
access:  private


Parameters:

string   $action   action type

[ Top ]

method getActionSuccess [line 1168]

boolean getActionSuccess( )



Tags:

access:  public


[ Top ]

method getCatalog [line 1008]

array getCatalog( )

Returns views catalog.



Tags:

access:  public


[ Top ]

method getLocationId [line 1175]

int getLocationId( )



Tags:

access:  public


[ Top ]

method getMessage [line 1146]

string getMessage( )



Tags:

return:  action result message
access:  public


[ Top ]

method getMetas [line 1161]

array getMetas( )

Returns metadata.



Tags:

access:  public


[ Top ]

method getViewId [line 1153]

int getViewId( )



Tags:

return:  current view ID
access:  public


[ Top ]

method getWeights [line 1048]

array getWeights( )

Returns natural-orderedviews weights list.



Tags:

access:  private


[ Top ]

method insert [line 976]

void insert( stdClass $data, array $metas)

Wrapper for 'insert' action.



Tags:

access:  public


Parameters:

stdClass   $data   collection of viewable plugins state objects
array   $metas   metadata

[ Top ]

method lockResource [line 870]

void lockResource( )

Locks access to storage resource.



Tags:

access:  protected
abstract:  


Overridden in child classes as:

ViewFileContainer::lockResource()
ViewDbContainer::lockResource()

[ Top ]

method openResource [line 855]

void openResource( )

Opens a connection to storage resource.



Tags:

access:  protected
abstract:  


Overridden in child classes as:

ViewFileContainer::openResource()
Opens view-storage file.
ViewDbContainer::openResource()

[ Top ]

method processResource [line 865]

void processResource( )

Processes (read/write) content of storage resource.



Tags:

access:  protected
abstract:  


Overridden in child classes as:

ViewFileContainer::processResource()
ViewDbContainer::processResource()

[ Top ]

method readCatalog [line 1018]

void readCatalog( )

Reads views catalog content.



Tags:

access:  protected
abstract:  


Overridden in child classes as:

ViewFileContainer::readCatalog()
ViewDbContainer::readCatalog()

[ Top ]

method select [line 965]

stdClass select( int $viewId)

Wrapper for 'select' action.



Tags:

return:  plugin storage infos
access:  public


Parameters:

int   $viewId   view ID

[ Top ]

method setSelectData [line 893]

void setSelectData( )

Sets various data while loading a view.



Tags:

access:  protected


Overridden in child classes as:

ViewDbContainer::setSelectData()

[ Top ]

method setViewId [line 1134]

int setViewId( )

Computes next available view ID.



Tags:

access:  protected


Overridden in child classes as:

TestViewFileContainer::setViewId()

[ Top ]

method setWeightMeta [line 880]

void setWeightMeta( )

Updates metadata with weight info and removes viewLocationId info.



Tags:

access:  protected


Overridden in child classes as:

ViewDbContainer::setWeightMeta()

[ Top ]

method unlockResource [line 875]

void unlockResource( )

Unlocks access to storage resource.



Tags:

access:  protected
abstract:  


Overridden in child classes as:

ViewFileContainer::unlockResource()
ViewDbContainer::unlockResource()

[ Top ]

method update [line 988]

void update( int $viewId, stdClass $data, array $metas)

Wrapper for 'update' action.



Tags:

access:  public


Parameters:

int   $viewId   view ID
stdClass   $data   collection of viewable plugins state objects
array   $metas   metadata

[ Top ]

method updateCatalog [line 1028]

void updateCatalog( )

Adds new/updated view in views catalog.



Tags:

access:  protected


[ Top ]

method writeCatalog [line 1023]

void writeCatalog( )

Writes views catalog content.



Tags:

access:  protected
abstract:  


Overridden in child classes as:

ViewFileContainer::writeCatalog()
ViewDbContainer::writeCatalog()

[ Top ]


Class Constants

BASE_WEIGHT =  100000

[line 843]


[ Top ]



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