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

Class: ViewFileContainer

Source Location: /client/Views.php

Class Overview

ViewContainer
   |
   --ViewFileContainer

Views recording/loading to/from file.


Variables

Methods


Child classes:

TestViewFileContainer
Views recording/loading to/from file.

Inherited Constants

Inherited Variables

Inherited Methods

Class: ViewContainer

ViewContainer::__construct()
Constructor
ViewContainer::closeResource()
Closes connection to storage resource.
ViewContainer::computeLocationId()
Returns ID of view located right after current view.
ViewContainer::computeWeight()
Computes weight of current view to determine its location in the views list.
ViewContainer::delete()
Wrapper for 'delete' action.
ViewContainer::doAction()
Performs view processing.
ViewContainer::getActionSuccess()
ViewContainer::getCatalog()
Returns views catalog.
ViewContainer::getLocationId()
ViewContainer::getMessage()
ViewContainer::getMetas()
Returns metadata.
ViewContainer::getViewId()
ViewContainer::getWeights()
Returns natural-orderedviews weights list.
ViewContainer::insert()
Wrapper for 'insert' action.
ViewContainer::lockResource()
Locks access to storage resource.
ViewContainer::openResource()
Opens a connection to storage resource.
ViewContainer::processResource()
Processes (read/write) content of storage resource.
ViewContainer::readCatalog()
Reads views catalog content.
ViewContainer::select()
Wrapper for 'select' action.
ViewContainer::setSelectData()
Sets various data while loading a view.
ViewContainer::setViewId()
Computes next available view ID.
ViewContainer::setWeightMeta()
Updates metadata with weight info and removes viewLocationId info.
ViewContainer::unlockResource()
Unlocks access to storage resource.
ViewContainer::update()
Wrapper for 'update' action.
ViewContainer::updateCatalog()
Adds new/updated view in views catalog.
ViewContainer::writeCatalog()
Writes views catalog content.

Class Details

[line 1222]
Views recording/loading to/from file.



[ Top ]


Class Variables

$cartoclient =

[line 1247]



Tags:

access:  private

Type:   Cartoclient


[ Top ]

$catalogFile =

[line 1242]



Tags:

access:  private

Type:   string


[ Top ]

$fileName =

[line 1237]



Tags:

access:  private

Type:   string


[ Top ]

$handle =

[line 1232]



Tags:

access:  private

Type:   string


[ Top ]

$viewPath =

[line 1227]



Tags:

access:  private

Type:   string


[ Top ]



Class Methods


constructor __construct [line 1253]

ViewFileContainer __construct( Cartoclient $cartoclient)

Constructor



Tags:

access:  public


Overrides ViewContainer::__construct() (Constructor)

Parameters:

Cartoclient   $cartoclient  

[ Top ]

method closeResource [line 1351]

void closeResource( )

Closes view-storage file.



Tags:

access:  protected
see:  ViewContainer::closeResource()


Overrides ViewContainer::closeResource() (Closes connection to storage resource.)

[ Top ]

method delete [line 1442]

boolean delete( mixed $viewId)

Deletes given view.



Tags:

return:  true if deletion succeeded
access:  public
see:  ViewContainer::delete()


Overrides ViewContainer::delete() (Wrapper for 'delete' action.)

[ Top ]

method getFileName [line 1317]

string getFileName( )

Returns view-storage filepath.



Tags:

return:  filepath
access:  private


[ Top ]

method lockResource [line 1392]

void lockResource( )



Tags:

access:  protected
see:  ViewContainer::lockResource()


Overrides ViewContainer::lockResource() (Locks access to storage resource.)

[ Top ]

method openResource [line 1333]

boolean openResource( )

Opens view-storage file.



Tags:

return:  true if success
access:  protected
see:  ViewContainer::openResource()


Overrides ViewContainer::openResource() (Opens a connection to storage resource.)

[ Top ]

method processResource [line 1359]

boolean processResource( )



Tags:

return:  true if success
access:  protected
see:  ViewContainer::processResource()


Overrides ViewContainer::processResource() (Processes (read/write) content of storage resource.)

[ Top ]

method readCatalog [line 1274]

array readCatalog( )



Tags:

access:  protected
see:  ViewContainer::readCatalog()


Overrides ViewContainer::readCatalog() (Reads views catalog content.)

[ Top ]

method readXmlContent [line 1407]

void readXmlContent( string $content)

Reads XML content and assigns view info.



Tags:

access:  private


Parameters:

string   $content  

[ Top ]

method unlockResource [line 1399]

void unlockResource( )



Tags:

access:  protected
see:  ViewContainer::unlockResource()


Overrides ViewContainer::unlockResource() (Unlocks access to storage resource.)

[ Top ]

method writeCatalog [line 1294]

void writeCatalog( )



Tags:

access:  protected
see:  ViewContainer::writeCatalog()


Overrides ViewContainer::writeCatalog() (Writes views catalog content.)

[ Top ]

method writeXmlContent [line 1423]

string writeXmlContent( )

Writes an XML string containing the view data and metadata.



Tags:

return:  XML
access:  private


[ Top ]


Documentation generated on Mon, 09 Sep 2013 13:31:25 +0200 by phpDocumentor 1.3.0RC3