arConnectorSession Class Reference

Class arConnectorSession. More...

Inheritance diagram for arConnectorSession:

Collaboration diagram for arConnectorSession:

Public Member Functions
	checkConnection (ActiveRecord $ar)
	nextID (ActiveRecord $ar)
	installDatabase (ActiveRecord $ar, $fields)
	updateDatabase (ActiveRecord $ar)
	resetDatabase (ActiveRecord $ar)
	truncateDatabase (ActiveRecord $ar)
	checkTableExists (ActiveRecord $ar)
	checkFieldExists (ActiveRecord $ar, $field_name)
	removeField (ActiveRecord $ar, $field_name)
	renameField (ActiveRecord $ar, $old_name, $new_name)
	create (ActiveRecord $ar)
	read (ActiveRecord $ar)
	update (ActiveRecord $ar)
	delete (ActiveRecord $ar)
	readSet (ActiveRecordList $arl)
	affectedRows (ActiveRecordList $arl)
	quote ($value, $type)
	updateIndices (ActiveRecord $ar)
Public Member Functions inherited from arConnector
	nextID (ActiveRecord $ar)
	checkConnection (ActiveRecord $ar)
	installDatabase (ActiveRecord $ar, $fields)
	updateDatabase (ActiveRecord $ar)
	resetDatabase (ActiveRecord $ar)
	truncateDatabase (ActiveRecord $ar)
	checkTableExists (ActiveRecord $ar)
	checkFieldExists (ActiveRecord $ar, $field_name)
	removeField (ActiveRecord $ar, $field_name)
	renameField (ActiveRecord $ar, $old_name, $new_name)
	create (ActiveRecord $ar)
	read (ActiveRecord $ar)
	update (ActiveRecord $ar)
	delete (ActiveRecord $ar)
	readSet (ActiveRecordList $arl)
	affectedRows (ActiveRecordList $arl)
	quote ($value, $type)
	updateIndices (ActiveRecord $ar)

Static Public Member Functions
static	resetSession ()
static	getSession ()
static	getSessionForActiveRecord (ActiveRecord $ar)

Data Fields
const	AR_CONNECTOR_SESSION = 'arConnectorSession'

Detailed Description

Class arConnectorSession.

Author

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

Version

2.0.7

Definition at line 11 of file class.arConnectorSession.php.

Member Function Documentation

affectedRows()

arConnectorSession::affectedRows

(

ActiveRecordList

$arl

)

Parameters

ActiveRecordList

$arl

Returns

int

Definition at line 234 of file class.arConnectorSession.php.

References readSet().

                                                            {
                return count($this->readSet($arl));
        }

Here is the call graph for this function:

checkConnection()

arConnectorSession::checkConnection

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

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

                                                          {
                return is_array(self::getSession());
        }

checkFieldExists()

arConnectorSession::checkFieldExists	(	ActiveRecord	$ar,
			$field_name
	)

Parameters

ActiveRecord	$ar
	$field_name

Returns

mixed

Definition at line 128 of file class.arConnectorSession.php.

                                                                        {
                $session = self::getSessionForActiveRecord($ar);

                return array_key_exists($field_name, $session[0]);
        }

checkTableExists()

arConnectorSession::checkTableExists

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

mixed

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

                                                           {
                return is_array(self::getSessionForActiveRecord($ar));
        }

create()

arConnectorSession::create

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Definition at line 163 of file class.arConnectorSession.php.

References $_SESSION, ActiveRecord\__asStdClass(), and ActiveRecord\getPrimaryFieldValue().

                                                 {
                $_SESSION[self::AR_CONNECTOR_SESSION][$ar::returnDbTableName()][$ar->getPrimaryFieldValue()] = $ar->__asStdClass();
        }

Here is the call graph for this function:

delete()

arConnectorSession::delete

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Definition at line 191 of file class.arConnectorSession.php.

References $_SESSION.

                                                 {
                unset($_SESSION[self::AR_CONNECTOR_SESSION][$ar::returnDbTableName()][$ar->getPrimaryFieldValue()]);
        }

getSession()

static arConnectorSession::getSession ( )

static

Returns

array

Definition at line 24 of file class.arConnectorSession.php.

References $_SESSION.

                                            {
                if (!$_SESSION[self::AR_CONNECTOR_SESSION]) {
                        self::resetSession();
                }

                return $_SESSION[self::AR_CONNECTOR_SESSION];
        }

getSessionForActiveRecord()

static arConnectorSession::getSessionForActiveRecord ( ActiveRecord  $ar )

static

Parameters

ActiveRecord

$ar

Returns

array

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

                                                                           {
                $session = self::getSession();
                $ar_session = $session[$ar::returnDbTableName()];
                if (!is_array($ar_session)) {
                        $ar_session = array();
                }

                return $ar_session;
        }

installDatabase()

arConnectorSession::installDatabase	(	ActiveRecord	$ar,
			$fields
	)

Parameters

ActiveRecord	$ar
	$fields

Returns

bool

Definition at line 75 of file class.arConnectorSession.php.

                                                                   {
                return self::resetDatabase($ar);
        }

nextID()

arConnectorSession::nextID

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

mixed

Definition at line 64 of file class.arConnectorSession.php.

                                                 {
                return count(self::getSessionForActiveRecord($ar)) + 1;
        }

quote()

arConnectorSession::quote	(		$value,
			$type
	)

Parameters

$value
$type

Returns

string

Definition at line 245 of file class.arConnectorSession.php.

                                             {
                return $value;
        }

read()

arConnectorSession::read

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

array

Definition at line 173 of file class.arConnectorSession.php.

References ActiveRecord\getPrimaryFieldValue().

                                               {
                $session = self::getSessionForActiveRecord($ar);

                return array( $session[$ar->getPrimaryFieldValue()] );
        }

Here is the call graph for this function:

readSet()

arConnectorSession::readSet

(

ActiveRecordList

$arl

)

Parameters

ActiveRecordList

$arl

Definition at line 203 of file class.arConnectorSession.php.

References $w, ActiveRecordList\getAR(), and ActiveRecordList\getArWhereCollection().

Referenced by affectedRows().

                                                       {
                $session = self::getSessionForActiveRecord($arl->getAR());
                foreach ($session as $i => $s) {
                        $session[$i] = (array)$s;
                }
                foreach ($arl->getArWhereCollection()->getWheres() as $w) {
                        $fieldname = $w->getFieldname();
                        $v = $w->getValue();
                        $operator = $w->getOperator();

                        foreach ($session as $i => $s) {
                                $session[$i] = (array)$s;
                                switch ($operator) {
                                        case '=':
                                                if ($s[$fieldname] != $v) {
                                                        unset($session[$i]);
                                                }
                                                break;
                                }
                        }
                }

                return $session;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

removeField()

arConnectorSession::removeField	(	ActiveRecord	$ar,
			$field_name
	)

Parameters

ActiveRecord	$ar
	$field_name

Returns

bool

Exceptions

arException

Definition at line 142 of file class.arConnectorSession.php.

                                                                   {
                return true;
        }

renameField()

arConnectorSession::renameField	(	ActiveRecord	$ar,
			$old_name,
			$new_name
	)

Parameters

ActiveRecord	$ar
	$old_name
	$new_name

Returns

bool

Exceptions

arException

Definition at line 155 of file class.arConnectorSession.php.

                                                                            {
                return true;
        }

resetDatabase()

arConnectorSession::resetDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

Definition at line 95 of file class.arConnectorSession.php.

References $_SESSION.

                                                        {
                $_SESSION[self::AR_CONNECTOR_SESSION][$ar::returnDbTableName()] = array();

                return true;
        }

resetSession()

static arConnectorSession::resetSession ( )

static

Definition at line 16 of file class.arConnectorSession.php.

References $_SESSION.

                                              {
                $_SESSION[self::AR_CONNECTOR_SESSION] = array();
        }

truncateDatabase()

arConnectorSession::truncateDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

Definition at line 107 of file class.arConnectorSession.php.

                                                           {
                return self::resetDatabase($ar);
        }

update()

arConnectorSession::update

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Definition at line 183 of file class.arConnectorSession.php.

                                                 {
                self::create($ar);
        }

updateDatabase()

arConnectorSession::updateDatabase

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Returns

bool

Definition at line 85 of file class.arConnectorSession.php.

                                                         {
                return true;
        }

updateIndices()

arConnectorSession::updateIndices

(

ActiveRecord

$ar

)

Parameters

ActiveRecord

$ar

Definition at line 253 of file class.arConnectorSession.php.

                                                        {
                // TODO: Implement updateIndices() method.
        }

Field Documentation

AR_CONNECTOR_SESSION

const arConnectorSession::AR_CONNECTOR_SESSION = 'arConnectorSession'

Definition at line 13 of file class.arConnectorSession.php.

---

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

• Services/ActiveRecord/Connector/class.arConnectorSession.php