Client
[ class tree: Client ] [ index: Client ] [ all elements ]
Packages:
CartoWeb3
Client
Common
CorePlugins
Htdocs
Plugins
Scripts
Server
Tests


Files:
AjaxHelper.php
Cartoclient.php
CartoserverService.php
ClientMapInfoCache.php
ClientPlugin.php
ClientPluginHelper.php
ClientProjectHandler.php
ExportPlugin.php
FormRenderer.php
HttpRequestHandler.php
Internationalization.php
MapInfoCache.php
ServerMapInfoCache.php
Smarty_Cartoclient.php
Views.php

Classes:
Ajaxable
AjaxException
AjaxPluginResponse
Cartoclient
CartoclientException
CartoForm
CartoserverService
ClientAccountingImpl
ClientConfig
ClientExportRtf
ClientMapInfoCache
ClientPlugin
ClientPluginConfig
ClientPluginHelper
ClientProjectHandler
ClientSession
DhtmlSelectionParser
EncoderInterface
EncoderISO
EncoderUTF
Exportable
ExportConfiguration
ExportOutput
ExportPlugin
FilterProvider
FilterRequestModifier
FormRenderer
GuiProvider
HttpRequestHandler
I18n
I18nDummy
I18nGettext
I18nInterface
InitUser
InitUserHelper
Json
PixelCoordsConverter
PluginEnabler
ServerCaller
ServerCallerHelper
Sessionable
SessionableHelper
Smarty_Cartoclient
Smarty_Plugin
SoapFaultWrapper
ToolDescription
ToolProvider
ToolProviderHelper
ViewContainer
ViewDbContainer
ViewFileContainer
ViewFilter
ViewHooks
ViewManager
ViewUpgrader

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 822]

Views recording/loading.





Tags:





  

    abstract:  
  










[ Top ]







Class Variables



	
	

	
$action = 

	
[line 832]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$catalog = 

	
[line 857]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$data = 

	
[line 847]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$isActionSuccess = 

	
[line 867]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$locationId =  0

	
[line 877]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$log = 

	
[line 827]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Logger
    

      

	



	
[ Top ]


	
	

	
$message = 

	
[line 842]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$metas = 

	
[line 852]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$viewId = 

	
[line 837]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$weight = 

	
[line 872]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

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

	
[line 862]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 884]

	

    

    

		ViewContainer __construct(
)
    

    


	
		Constructor





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
ViewFileContainer::__construct()

		
Constructor

	

		

	
ViewDbContainer::__construct()

		
Constructor

	

	


        
[ Top ]

  

  

	
	
method closeResource [line 896]

	

    

    

		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 1150]

	

    

    

		int computeLocationId(
)
    

    


	
		Returns ID of view located right after current view.





Tags:





  

    access:  private
  










        
[ Top ]

  

  

	
	
method computeWeight [line 1097]

	

    

    

		void computeWeight(
)
    

    


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





Tags:





  

    access:  private
  










        
[ Top ]

  

  

	
	
method delete [line 1035]

	

    

    

		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 938]

	

    

    

		boolean doAction(
string
$action)
    

    


	
		Performs view processing.





Tags:





  

    return:  if true, action succeeded
  

  

    access:  private
  










        
Parameters:

    

    

          

        string  
        $action  
        action type
      

        

    


        
[ Top ]

  

  

	
	
method getActionSuccess [line 1204]

	

    

    

		boolean getActionSuccess(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getCatalog [line 1044]

	

    

    

		array getCatalog(
)
    

    


	
		Returns views catalog.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getLocationId [line 1211]

	

    

    

		int getLocationId(
)
    

    


	
		



Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMessage [line 1182]

	

    

    

		string getMessage(
)
    

    


	
		



Tags:





  

    return:  action result message
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getMetas [line 1197]

	

    

    

		array getMetas(
)
    

    


	
		Returns metadata.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getViewId [line 1189]

	

    

    

		int getViewId(
)
    

    


	
		



Tags:





  

    return:  current view ID
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getWeights [line 1084]

	

    

    

		array getWeights(
)
    

    


	
		Returns natural-orderedviews weights list.





Tags:





  

    access:  private
  










        
[ Top ]

  

  

	
	
method insert [line 1012]

	

    

    

		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 906]

	

    

    

		void lockResource(
)
    

    


	
		Locks access to storage resource.





Tags:





  

    access:  protected
  

  

    abstract:  
  









	
Overridden in child classes as:

		

	
ViewFileContainer::lockResource()

		

	

		

	
ViewDbContainer::lockResource()

		

	

	


        
[ Top ]

  

  

	
	
method openResource [line 891]

	

    

    

		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 901]

	

    

    

		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 1054]

	

    

    

		void readCatalog(
)
    

    


	
		Reads views catalog content.





Tags:





  

    access:  protected
  

  

    abstract:  
  









	
Overridden in child classes as:

		

	
ViewFileContainer::readCatalog()

		

	

		

	
ViewDbContainer::readCatalog()

		

	

	


        
[ Top ]

  

  

	
	
method select [line 1001]

	

    

    

		stdClass select(
int
$viewId)
    

    


	
		Wrapper for 'select' action.





Tags:





  

    return:  plugin storage infos
  

  

    access:  public
  










        
Parameters:

    

    

          

        int  
        $viewId  
        view ID
      

        

    


        
[ Top ]

  

  

	
	
method setSelectData [line 929]

	

    

    

		void setSelectData(
)
    

    


	
		Sets various data while loading a view.





Tags:





  

    access:  protected
  









	
Overridden in child classes as:

		

	
ViewDbContainer::setSelectData()

		

	

	


        
[ Top ]

  

  

	
	
method setViewId [line 1170]

	

    

    

		int setViewId(
)
    

    


	
		Computes next available view ID.





Tags:





  

    access:  protected
  









	
Overridden in child classes as:

		

	
TestViewFileContainer::setViewId()

		

	

	


        
[ Top ]

  

  

	
	
method setWeightMeta [line 916]

	

    

    

		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 911]

	

    

    

		void unlockResource(
)
    

    


	
		Unlocks access to storage resource.





Tags:





  

    access:  protected
  

  

    abstract:  
  









	
Overridden in child classes as:

		

	
ViewFileContainer::unlockResource()

		

	

		

	
ViewDbContainer::unlockResource()

		

	

	


        
[ Top ]

  

  

	
	
method update [line 1024]

	

    

    

		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 1064]

	

    

    

		void updateCatalog(
)
    

    


	
		Adds new/updated view in views catalog.





Tags:





  

    access:  protected
  










        
[ Top ]

  

  

	
	
method writeCatalog [line 1059]

	

    

    

		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 879]

  
  

	
[ Top ]






        

		    

		    Documentation generated on Fri, 21 Sep 2007 13:31:11 +0200 by phpDocumentor 1.3.0RC3