Class: BlueBox_Config

Source Location: /BlueBox_Config.php

Class Overview

Created on 23 jan 07

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

Class Details

[line 16]
Created on 23 jan 07

This class manages BlueBox Config objects.

Changes: 1.0 to 2.0: phpdoc compatible in the way to generate documentation

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	2.0
license:	GNU Public License

[ Top ]

Class Variables

$database = "bluebox"

[line 22]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$debug =

[line 54]

Variable that contains debug switch

Tags:

access:

public

Type:

bool

[ Top ]

$error =

[line 49]

Variable that contains execution errors

Tags:

access:

public

Type:

array

[ Top ]

$result =

[line 44]

Variable that contains SQL query result

Tags:

access:

public

Type:

array

[ Top ]

$table = "config"

[line 27]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$variable_name =

[line 33]

Variable that contains variable name

Tags:

access:

public

Type:

string

[ Top ]

$variable_value =

[line 38]

Variable that contains variable value

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

method OnStartup [line 120]

array OnStartup(
)

On Startup variable / value obtention function

This function is used to get config variables on startup. Result is returned

<?php
$oBB_C = new BlueBox_Config();
print_r($oBB_C->OnStartup());
// onstartupvars
?>

Tags:

return:	variables that must be set on startup
since:	Version 1.0
uses:	MySQL::SelectRow()

[ Top ]

method ValueByName [line 78]

string ValueByName(
string
$this->variable_name)

Variable value obtention function

This function is used to obtain a value by variable name. Result is stored in $this->variable_value and returned

<?php
$oBB_C = new BlueBox_Config();
$oBB_C->variable_name = "foovar";
echo $oBB_C->ValueByName();
// barvalue
?>

Tags:

return:	value of the variable
since:	Version 1.0
usedby:	BlueBox_CacheControl::__construct()
uses:	MySQL::SelectRow()

Parameters:

string

$this->variable_name

name of the variable to be searched in database (required)

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:29:58 +0200 by phpDocumentor 1.4.1