phpDocumentor pivotx
[ class tree: pivotx ] [ index: pivotx ] [ all elements ]

Class: Config

Source Location: /objects.php

Class Config

Class Overview

Takes care of all configuration settings. The configuration is stored in pivotx/db/ser_config.php, but is completely accessible through this object.

Saving is automagical and only when something has changed.

Located in /objects.php [line 196]

BaseConfig
   |
   --Config

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From BaseConfig

BaseConfig::$backup_configfile
BaseConfig::$changed
BaseConfig::$configfile
BaseConfig::$data
BaseConfig::$upgraded

Inherited From BaseConfig

BaseConfig::__construct()
Constructor
BaseConfig::count()
Return configuration-array size
BaseConfig::fixConfig()
Fix configuration (this should be overwritten in subclass)
BaseConfig::initConfig()
Initialise configuration after has been read, fixed and organized.
BaseConfig::loadConfig()
Load and verify config
BaseConfig::organizeConfig()
Organize configuration
BaseConfig::print_r()
Print a comprehensible representation of the users
BaseConfig::save()
Old save version
BaseConfig::saveConfig()
Save configuration if 'safe' to do so
BaseConfig::setChanged()
Set changed flag
BaseConfig::setUpgraded()
Set upgraded
BaseConfig::verifyConfig()
Verify configuration (this should be overwritten in subclass)

[ Top ]
Method Summary
Config   __construct()  
Config   Config()  
void   del()   Delete a configuration value. Use with extreme caution. Saves the configuration afterwards
void   fixConfig()  
string   get()   Gets a single value from the configuration.
array   getConfigArray()   Return the entire config as a big array.. It's probable better to use $PIVOTX['config']->get() if you only need one or few items.
void   readOld()   If the config file is missing, we check if there's a pivot 1.x config
void   set()   Sets a configuration value, and then saves it.
void   verifyConfig()  

[ Top ]
Methods
Constructor __construct  [line 197]

  Config __construct( [ $sites_path = '']  )

Parameters:
   $sites_path: 

API Tags:
Access:  public


Redefinition of:
BaseConfig::__construct()
Constructor

[ Top ]
Constructor Config  [line 203]

  Config Config( [ $sites_path = '']  )

Parameters:
   $sites_path: 

API Tags:
Access:  public


[ Top ]
del  [line 377]

  void del( string $key  )

Delete a configuration value. Use with extreme caution. Saves the configuration afterwards

Parameters:
string   $key: 


[ Top ]
fixConfig  [line 231]

  void fixConfig( )


API Tags:
Access:  protected


Redefinition of:
BaseConfig::fixConfig()
Fix configuration (this should be overwritten in subclass)

[ Top ]
get  [line 395]

  string get( string $key  )

Gets a single value from the configuration.

Parameters:
string   $key: 


[ Top ]
getConfigArray  [line 339]

  array getConfigArray( )

Return the entire config as a big array.. It's probable better to use $PIVOTX['config']->get() if you only need one or few items.


API Tags:
See:  $this->get


[ Top ]
readOld  [line 271]

  void readOld( )

If the config file is missing, we check if there's a pivot 1.x config

file that we can use. This function does some comversions to get it up to date, and sets it in $this->data


API Tags:
Access:  protected


[ Top ]
set  [line 351]

  void set( string $key, unknown_type $value  )

Sets a configuration value, and then saves it.

Parameters:
string   $key: 
unknown_type   $value: 


[ Top ]
verifyConfig  [line 207]

  void verifyConfig( )


API Tags:
Access:  protected


Redefinition of:
BaseConfig::verifyConfig()
Verify configuration (this should be overwritten in subclass)

[ Top ]

Documentation generated on Tue, 22 Aug 2017 01:06:13 +0200 by phpDocumentor 1.4.3