arConnectorSession Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for arConnectorSession:

Collaboration diagram for arConnectorSession:

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

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

Data Fields
const	AR_CONNECTOR_SESSION = 'arConnectorSession'

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 24 of file class.arConnectorSession.php.

Member Function Documentation

affectedRows()

arConnectorSession::affectedRows

(

ActiveRecordList

$activeRecordList

)

Reimplemented from arConnector.

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

                                                                    : int
    {
        return count($this->readSet($activeRecordList));
    }

References readSet().

Here is the call graph for this function:

checkConnection()

arConnectorSession::checkConnection

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

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

checkFieldExists()

arConnectorSession::checkFieldExists	(	ActiveRecord	$activeRecord,
		string	$field_name
	)

Reimplemented from arConnector.

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

                                                                                    : bool
    {
        $session = self::getSessionForActiveRecord($activeRecord);
 
        return array_key_exists($field_name, $session[0]);
    }

References getSessionForActiveRecord().

Here is the call graph for this function:

checkTableExists()

arConnectorSession::checkTableExists

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

                                                                : bool
    {
        return is_array(self::getSessionForActiveRecord($activeRecord));
    }

create()

arConnectorSession::create

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

                                                      : void
    {
        $_SESSION[self::AR_CONNECTOR_SESSION][$activeRecord::returnDbTableName()][$activeRecord->getPrimaryFieldValue(
        )] = $activeRecord->asStdClass();
    }

References AR_CONNECTOR_SESSION, ActiveRecord\asStdClass(), and ActiveRecord\getPrimaryFieldValue().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

arConnectorSession::delete

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

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

getSession()

static arConnectorSession::getSession ( )

static

Returns

mixed[]

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

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

References AR_CONNECTOR_SESSION, and resetSession().

Referenced by getSessionForActiveRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

getSessionForActiveRecord()

static arConnectorSession::getSessionForActiveRecord ( ActiveRecord  $activeRecord )

static

Returns

mixed[]

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

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

References getSession().

Referenced by checkFieldExists(), read(), and readSet().

Here is the call graph for this function:

Here is the caller graph for this function:

installDatabase()

arConnectorSession::installDatabase	(	ActiveRecord	$activeRecord,
		array	$fields
	)

Reimplemented from arConnector.

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

                                                                              : bool
    {
        return $this->resetDatabase($activeRecord);
    }

References resetDatabase().

Here is the call graph for this function:

nextID()

arConnectorSession::nextID

(

ActiveRecord

$activeRecord

)

Returns

mixed

Reimplemented from arConnector.

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

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

quote()

arConnectorSession::quote	(		$value,
		string	$type
	)

Parameters

$value

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

                                               : string
    {
        return $value;
    }

read()

arConnectorSession::read

(

ActiveRecord

$activeRecord

)

Returns

mixed[]

Reimplemented from arConnector.

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

                                                    : array
    {
        $session = self::getSessionForActiveRecord($activeRecord);
 
        return [$session[$activeRecord->getPrimaryFieldValue()]];
    }

References ActiveRecord\getPrimaryFieldValue(), and getSessionForActiveRecord().

Here is the call graph for this function:

readSet()

arConnectorSession::readSet

(

ActiveRecordList

$activeRecordList

)

Returns

mixed[]

Reimplemented from arConnector.

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

                                                               : array
    {
        $session = self::getSessionForActiveRecord($activeRecordList->getAR());
        foreach ($session as $i => $s) {
            $session[$i] = (array) $s;
        }
        foreach ($activeRecordList->getArWhereCollection()->getWheres() as $arWhere) {
            $fieldname = $arWhere->getFieldname();
            $v = $arWhere->getValue();
            $operator = $arWhere->getOperator();
 
            foreach ($session as $i => $s) {
                $session[$i] = (array) $s;
                if ($operator !== '=') {
                    continue;
                }
                if ($s[$fieldname] === $v) {
                    continue;
                }
                unset($session[$i]);
            }
        }
 
        return $session;
    }

References ActiveRecordList\getAR(), ActiveRecordList\getArWhereCollection(), and getSessionForActiveRecord().

Referenced by affectedRows().

Here is the call graph for this function:

Here is the caller graph for this function:

removeField()

arConnectorSession::removeField	(	ActiveRecord	$activeRecord,
		string	$field_name
	)

Exceptions

arException

Reimplemented from arConnector.

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

                                                                               : bool
    {
        return true;
    }

renameField()

arConnectorSession::renameField	(	ActiveRecord	$activeRecord,
		string	$old_name,
		string	$new_name
	)

Exceptions

arException

Reimplemented from arConnector.

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

                                                                                               : bool
    {
        return true;
    }

resetDatabase()

arConnectorSession::resetDatabase

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

                                                             : bool
    {
        $_SESSION[self::AR_CONNECTOR_SESSION][$activeRecord::returnDbTableName()] = [];
 
        return true;
    }

References AR_CONNECTOR_SESSION.

Referenced by installDatabase(), and truncateDatabase().

Here is the caller graph for this function:

resetSession()

static arConnectorSession::resetSession ( )

static

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

                                         : void
    {
        $_SESSION[self::AR_CONNECTOR_SESSION] = [];
    }

References AR_CONNECTOR_SESSION.

Referenced by getSession().

Here is the caller graph for this function:

truncateDatabase()

arConnectorSession::truncateDatabase

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

                                                                : bool
    {
        return $this->resetDatabase($activeRecord);
    }

References resetDatabase().

Here is the call graph for this function:

update()

arConnectorSession::update

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

                                                      : void
    {
        $this->create($activeRecord);
    }

References create().

Here is the call graph for this function:

updateDatabase()

arConnectorSession::updateDatabase

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

                                                              : bool
    {
        return true;
    }

updateIndices()

arConnectorSession::updateIndices

(

ActiveRecord

$activeRecord

)

Reimplemented from arConnector.

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

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

Field Documentation

AR_CONNECTOR_SESSION

const arConnectorSession::AR_CONNECTOR_SESSION = 'arConnectorSession'

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

Referenced by create(), getSession(), resetDatabase(), and resetSession().

---

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

• components/ILIAS/ActiveRecord/Connector/class.arConnectorSession.php