arConfig Class Reference

Class arConfig. More...

Inheritance diagram for arConfig:

Collaboration diagram for arConfig:

Public Member Functions
	setName ($name)
	getName ()
	setValue ($value)
	getValue ()
Public Member Functions inherited from ActiveRecord
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	setConnectorContainerName ($connector_container_name)
	getPrimaryFieldValue ()
	setPrimaryFieldValue ($value)
	__construct ($primary_key=0, arConnector $connector=null)
	storeObjectToCache ()
	__getConvertedDateFieldsAsArray ($format=null)
	__asCsv ($separator=';', $header=false)
	__asArray ()
	__asStdClass ()
	__asSerializedObject ()
	buildFromArray (array $array)
	fixDateField ($field_name, $value)
	sleep ($field_name)
	wakeUp ($field_name, $field_value)
	getArrayForDb ()
	getArrayForConnector ()
	installConnector ()
	store ()
	save ()
	create ()
	copy ($new_id=0)
	afterObjectLoad ()
	read ()
	update ()
	delete ()
	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()
static	get ($name)
static	set ($name, $value)
Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()
static	installDB ()
static	renameDBField ($old_name, $new_name)
static	tableExists ()
static	fieldExists ($field_name)
static	removeDBField ($field_name)
static	updateDB ()
static	resetDB ()
static	truncateDB ()
static	flushDB ()
static	preloadObjects ()
static	additionalParams (array $additional_params)
static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
static	findOrGetInstance ($primary_key, array $add_constructor_args=array())
static	where ($where, $operator=null)
static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	orderBy ($orderBy, $orderDirection='ASC')
static	dateFormat ($date_format='d.m.Y - H:i:s')
static	limit ($start, $end)
static	affectedRows ()
static	count ()
static	get ()
static	debug ()
static	first ()
static	getCollection ()
static	last ()
static	getFirstFromLastQuery ()
static	connector (arConnector $connector)
static	raw ($set_raw=true)
static	getArray ($key=null, $values=null)
static	_toCamelCase ($str, $capitalise_first_char=false)

Protected Attributes
	$name
	$value
Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true
	$connector_container_name = ''

Static Protected Attributes
static	$cache = array()
static	$cache_loaded = array()

Additional Inherited Members
Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'
Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...
	installDatabase ()
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
static	fromCamelCase ($str)

Detailed Description

Class arConfig.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

2.0.7

Definition at line 10 of file class.arConfig.php.

Member Function Documentation

get()

static arConfig::get (   $name )

static

Parameters

$name

Returns

string

Definition at line 38 of file class.arConfig.php.

References $name.

    {
        if (!self::$cache_loaded[$name]) {
            $obj = new self($name);
            self::$cache[$name] = $obj->getValue();
            self::$cache_loaded[$name] = true;
        }

        return self::$cache[$name];
    }

getName()

arConfig::getName

(

)

Returns

string

Definition at line 99 of file class.arConfig.php.

References $name.

    {
        return $this->name;
    }

getValue()

arConfig::getValue

(

)

Returns

string

Definition at line 117 of file class.arConfig.php.

References $value.

    {
        return $this->value;
    }

returnDbTableName()

static arConfig::returnDbTableName ( )

static

Returns

string Return the Name of your Database Table

Definition at line 17 of file class.arConfig.php.

    {
        return 'ar_demo_config';
    }

set()

static arConfig::set (   $name,   $value  )

static

Parameters

$name
$value

Definition at line 54 of file class.arConfig.php.

References $name, $value, and array.

Referenced by arConfigFormGUI\saveValueForItem().

    {
        $obj = new self($name);
        $obj->setValue($value);
        if (self::where(array( 'name' => $name ))->hasSets()) {
            $obj->update();
        } else {
            $obj->create();
        }
    }

Here is the caller graph for this function:

setName()

arConfig::setName

(

$name

)

Parameters

string

$name

Definition at line 90 of file class.arConfig.php.

References $name.

    {
        $this->name = $name;
    }

setValue()

arConfig::setValue

(

$value

)

Parameters

string

$value

Definition at line 108 of file class.arConfig.php.

References $value.

    {
        $this->value = $value;
    }

Field Documentation

$cache

arConfig::$cache = array()

staticprotected

Definition at line 26 of file class.arConfig.php.

$cache_loaded

arConfig::$cache_loaded = array()

staticprotected

Definition at line 30 of file class.arConfig.php.

$name

arConfig::$name

protected

Definition at line 76 of file class.arConfig.php.

Referenced by get(), getName(), set(), and setName().

$value

arConfig::$value

protected

Definition at line 84 of file class.arConfig.php.

Referenced by getValue(), set(), and setValue().

---

The documentation for this class was generated from the following file:

• Services/ActiveRecord/_Examples/Config/class.arConfig.php