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


Files:
Accounting.php
BasicTypes.php
ClientAccounting.php
Common.php
Config.php
CwSerializable.php
Log4phpInit.php
MapInfo.php
Message.php
PluginBase.php
PluginManager.php
ProjectHandler.php
Request.php
ResourceHandler.php
SecurityManager.php
ServerAccounting.php
ServerProjectHandler.php
ShapeConverter.php
StructHandler.php
Utils.php

Classes:
Accounting
Bbox
BboxConverter
Cartocommon
CartocommonException
CartowebException
ChildrenSwitch
Circle
CircleConverter
Common
Config
ConfigParser
CwSerializable
Dimension
DummyAccounting
Feature
GeoDimension
I18nNoop
InitialLocation
InitialMapState
Layer
LayerBase
LayerClass
LayerContainer
LayerGroup
LayerState
Line
LineConverter
Location
MapInfo
MapInfoCache
MapRequest
MapResult
Message
PluginBase
PluginConfig
PluginManager
Point
PointConverter
Polygon
PolygonConverter
ProjectHandler
Rectangle
RectangleConverter
ResourceHandler
SecurityContainer
SecurityManager
ServerProjectHandler
Shape
SoapFault
StructHandler
Utils

Class: Config

Source Location: /common/Config.php

Class Overview




Main configuration




Author(s):


    
        





    






Variables







Methods















Child classes:






ClientConfig

	
Configuration for client side






ServerConfig

	
Server configuration class






PluginConfig

	
Configuration for plugins

















Class Details



[line 28]

Main configuration





Tags:





  

    abstract:  
  










[ Top ]







Class Variables



	
	

	
$ini_array = 

	
[line 39]

  Array of string which contains contents of .ini configuration file





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$projectHandler = 

	
[line 33]

  



Tags:





  

    access:  public
  






  

	

  

    

      Type:  
      ProjectHandler
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 139]

	

    

    

		Config __construct(
ProjectHandler
$projectHandler)
    

    


	
		Constructor

Reads project's and default .ini file, sets project handler's mapId  and initializes paths.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
ClientConfig::__construct()

		
Constructor

	

		

	
ServerConfig::__construct()

		
Constructor

	

		

	
PluginConfig::__construct()

		
Constructor

	

		

	
ClientPluginConfig::__construct()

		
Constructor

	

		

	
ServerPluginConfig::__construct()

		
Constructor

	

	


        
Parameters:

    

    

          

        ProjectHandler  
        $projectHandler  
        
      

        

    


        
[ Top ]

  

  

	
	
method getBasePath [line 51]

	

    

    

		string getBasePath(
)
    

    


	
		Returns the client or server root path





Tags:





  

    access:  public
  

  

    abstract:  
  









	
Overridden in child classes as:

		

	
ClientConfig::getBasePath()

		
Returns base path

	

		

	
ServerConfig::getBasePath()

		

	

		

	
ClientPluginConfig::getBasePath()

		
Returns base path

	

		

	
ServerPluginConfig::getBasePath()

		

	

	


        
[ Top ]

  

  

	
	
method getIniArray [line 182]

	

    

    

		array getIniArray(
)
    

    


	
		Returns protected var $ini_array.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
AuthTestClientPluginConfig::getIniArray()

		

	

	


        
[ Top ]

  

  

	
	
method getKind [line 45]

	

    

    

		string getKind(
)
    

    


	
		Returns type of config ('client' or 'server')





Tags:





  

    access:  public
  

  

    abstract:  
  









	
Overridden in child classes as:

		

	
ClientConfig::getKind()

		
Returns config type

	

		

	
ServerConfig::getKind()

		

	

		

	
ClientPluginConfig::getKind()

		
Returns plugin config type

	

		

	
ServerPluginConfig::getKind()

		

	

	


        
[ Top ]

  

  

	
	
method getProfileParameters [line 80]

	

    

    

		array getProfileParameters(
)
    

    


	
		Return the name of the parameters which will be automatically set  from the current profile (overriding the one from configuration).

This method should be overriden to add more parameters. The overrider  should merge the array with its parent.





Tags:





  

    return:  Parameters which should be true when profile is development    or false in production.
  

  

    access:  protected
  









	
Overridden in child classes as:

		

	
ClientConfig::getProfileParameters()

		
{@see Config::getProfileParameters()})

	

		

	
ServerConfig::getProfileParameters()

		
{@see Config::getProfileParameters()})

	

	


        
[ Top ]

  

  

	
	
method setMapId [line 120]

	

    

    

		void setMapId(
string
$mapId)
    

    


	
		Sets mapId

Should be called in plugins initialize method.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $mapId  
        
      

        

    


        
[ Top ]

  

  

	
	
method updateProfileParameters [line 89]

	

    

    

		void updateProfileParameters(
)
    

    


	
		Set parameters values according to the current profile





Tags:





  

    access:  private
  

  

    see:  Config::getProfileParameters()
  










        
[ Top ]

  

  

	
	
method __get [line 62]

	

    

    

		string __get(
string
$nm)
    

    


	
		Property access method

Will return value set in .ini files or NULL if it doesn't exist  !! WARNING: do not use empty() to test agains properties returned  by __get(). It will be always empty !!





Tags:





  

    return:  value
  

  

    access:  public
  










        
Parameters:

    

    

          

        string  
        $nm  
        index
      

        

    


        
[ Top ]

  






        

		    

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