Inheritance diagram for ilAtomQueryBase:

Collaboration diagram for ilAtomQueryBase:

Public Member Functions
	__construct (ilDBInterface $ilDBInstance, $isolation_level=ilAtomQuery::ISOLATION_SERIALIZABLE)
	ilAtomQuery constructor. More...

	getRisks ()

	addTableLock ($table_name)
	Add table-names which are influenced by your queries, MyISAm has to lock those tables. More...

	addQueryCallable (callable $query)
	All action on the database during this isolation has to be passed as Callable to ilAtomQuery. More...

	replaceQueryCallable (callable $query)

	run ()
	Fire your Queries. More...

	getIsolationLevel ()

	checkCallable (callable $query)

	addTableLock ($table_name)
	Add table-names which are influenced by your queries, MyISAm has to lock those tables. More...

	addQueryCallable (callable $query)
	Every action on the database during this isolation has to be passed as Callable to ilAtomQuery. More...

	replaceQueryCallable (callable $query)
	Every action on the database during this isolation has to be passed as Callable to ilAtomQuery. More...

	run ()
	Fire your Queries. More...

	getIsolationLevel ()
	Returns the current Isolation-Level. More...

	checkCallable (callable $query)
	Provides a check if your callable is ready to be used in ilAtomQuery. More...

Static Public Member Functions
static	isThereRiskThat ($isolation_level, $anomaly)

static	getPossibleAnomalies ($isolation_level)

static	checkIsolationLevel ($isolation_level)

static	checkAnomaly ($anomalie)

static	checkIsolationLevel ($isolation_level)

Data Fields
const	ITERATIONS = 10

Data Fields inherited from ilAtomQuery
const	LOCK_WRITE = 1

const	LOCK_READ = 2

const	ISOLATION_READ_UNCOMMITED = 1

const	ISOLATION_READ_COMMITED = 2

const	ISOLATION_REPEATED_READ = 3

const	ISOLATION_SERIALIZABLE = 4

const	ANO_LOST_UPDATES = 1

const	ANO_DIRTY_READ = 2

const	ANO_NON_REPEATED_READ = 3

const	ANO_PHANTOM = 4

Protected Member Functions
	getDeterminedLockLevel ()

	checkQueries ()

	runQueries ()

	checkBeforeRun ()

Protected Attributes
	$isolation_level = ilAtomQuery::ISOLATION_SERIALIZABLE

	$tables = array()

	$query = null

	$ilDBInstance

Static Protected Attributes
static	$available_isolations_levels

static	$possible_anomalies

static	$anomalies_map

Detailed Description

Class ilAtomQuery.

Use ilAtomQuery to fire Database-Actions which have to be done without beeing influenced by other queries or which can influence other queries as well. Depending on the current Database-engine, this can be done by using transaction or with table-locks

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

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

Constructor & Destructor Documentation

◆ __construct()

ilAtomQueryBase::__construct	(	ilDBInterface	$ilDBInstance,
			$isolation_level = `ilAtomQuery::ISOLATION_SERIALIZABLE`
	)

ilAtomQuery constructor.

Parameters

\ilDBInterface	$ilDBInstance
int	$isolation_level	currently only ISOLATION_SERIALIZABLE is available

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

    {
        static::checkIsolationLevel($isolation_level);
        $this->ilDBInstance = $ilDBInstance;
        $this->isolation_level = $isolation_level;
    }

References $ilDBInstance, and $isolation_level.

Member Function Documentation

◆ addQueryCallable()

ilAtomQueryBase::addQueryCallable ( callable $query )

All action on the database during this isolation has to be passed as Callable to ilAtomQuery.

An example (Closure): $ilAtomQuery->addQueryClosure( function (ilDBInterface $ilDB) use ($new_obj_id, $current_id) { $ilDB->doStuff(); });

An example (Callable Class): class ilMyAtomQueryClass { public function __invoke(ilDBInterface $ilDB) { $ilDB->doStuff(); } }

$ilAtomQuery->addQueryClosure(new ilMyAtomQueryClass());

Parameters

\callable $query

Exceptions

ilAtomQueryException

Implements ilAtomQuery.

Definition at line 150 of file class.ilAtomQueryBase.php.

    {
        if ($this->query) {
            throw new ilAtomQueryException('', ilAtomQueryException::DB_ATOM_CLOSURE_ALREADY_SET);
        }
        if (!$this->checkCallable($query)) {
            throw new ilAtomQueryException('', ilAtomQueryException::DB_ATOM_CLOSURE_WRONG_FORMAT);
        }
        $this->query = $query;
    }

References $query, checkCallable(), ilAtomQueryException\DB_ATOM_CLOSURE_ALREADY_SET, and ilAtomQueryException\DB_ATOM_CLOSURE_WRONG_FORMAT.

Here is the call graph for this function:

◆ addTableLock()

ilAtomQueryBase::addTableLock ( $table_name )

Add table-names which are influenced by your queries, MyISAm has to lock those tables.

You get an ilTableLockInterface with further possibilities, e.g.:

$ilAtomQuery->addTableLock('my_table')->lockSequence(true)->aliasName('my_alias');

the lock-level is determined by ilAtomQuery

Parameters

$table_name

Returns: \ilTableLockInterface

Implements ilAtomQuery.

Definition at line 105 of file class.ilAtomQueryBase.php.

    {
        $ilTableLock = new ilTableLock($table_name, $this->ilDBInstance);
        $ilTableLock->setLockLevel($this->getDeterminedLockLevel());
        $this->tables[] = $ilTableLock;
 
        return $ilTableLock;
    }

References getDeterminedLockLevel().

Here is the call graph for this function:

◆ checkAnomaly()

static ilAtomQueryBase::checkAnomaly ( $anomalie )

static

Parameters

$anomalie

Exceptions

ilAtomQueryException

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

    {
        if (!in_array($anomalie, self::$possible_anomalies)) {
            throw new ilAtomQueryException($anomalie, ilAtomQueryException::DB_ATOM_ANO_NOT_AVAILABLE);
        }
    }

References ilAtomQueryException\DB_ATOM_ANO_NOT_AVAILABLE.

Referenced by ilDatabaseAtomBaseTest\testAnomalies().

Here is the caller graph for this function:

◆ checkBeforeRun()

ilAtomQueryBase::checkBeforeRun ( )

protected

Exceptions

ilAtomQueryException

Definition at line 347 of file class.ilAtomQueryBase.php.

    {
        $this->checkQueries();
 
        if ($this->hasWriteLocks() && $this->getIsolationLevel() != ilAtomQuery::ISOLATION_SERIALIZABLE) {
            throw new ilAtomQueryException('', ilAtomQueryException::DB_ATOM_LOCK_WRONG_LEVEL);
        }
 
        if (count($this->tables) === 0) {
            throw new ilAtomQueryException('', ilAtomQueryException::DB_ATOM_LOCK_NO_TABLE);
        }
    }

References checkQueries(), ilAtomQueryException\DB_ATOM_LOCK_NO_TABLE, ilAtomQueryException\DB_ATOM_LOCK_WRONG_LEVEL, getIsolationLevel(), and ilAtomQuery\ISOLATION_SERIALIZABLE.

Referenced by ilAtomQueryLock\run(), and ilAtomQueryTransaction\run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkCallable()

ilAtomQueryBase::checkCallable ( callable $query )

Parameters

callable $query

Returns: bool

Implements ilAtomQuery.

Definition at line 274 of file class.ilAtomQueryBase.php.

    {
        if (!is_callable($query)) {
            return false; // Won't be triggered sidn type-hinting already checks this
        }
        if (is_array($query)) {
            return false;
        }
        if (is_string($query)) {
            return false;
        }
        $classname = get_class($query);
        $is_a_closure = $classname == 'Closure';
        if (!$is_a_closure) {
            $ref = new ReflectionClass($query);
            foreach ($ref->getMethods() as $method) {
                if ($method->getName() == '__invoke') {
                    return true;
                }
            }
 
            return false;
        }
        if ($is_a_closure) {
            $ref = new ReflectionFunction($query);
            $parameters = $ref->getParameters();
            if (count($parameters) !== 1) {
                return false;
            }
            $reflectionClass = $parameters[0]->getClass();
            if ($reflectionClass && $reflectionClass->getName() == 'ilDBInterface') {
                return true;
            }
 
            return false;
        }
 
        return true;
    }

References $query.

Referenced by addQueryCallable(), checkQueries(), and replaceQueryCallable().

Here is the caller graph for this function:

◆ checkIsolationLevel()

static ilAtomQueryBase::checkIsolationLevel ( $isolation_level )

static

Parameters

$isolation_level

Exceptions

ilAtomQueryException

Implements ilAtomQuery.

Definition at line 224 of file class.ilAtomQueryBase.php.

    {
        // The following Isolations are currently not supported
        if (in_array($isolation_level, array(
            ilAtomQuery::ISOLATION_READ_UNCOMMITED,
            ilAtomQuery::ISOLATION_READ_COMMITED,
            ilAtomQuery::ISOLATION_REPEATED_READ,
        ))) {
            throw new ilAtomQueryException($isolation_level, ilAtomQueryException::DB_ATOM_ISO_WRONG_LEVEL);
        }
        // Check if a available Isolation level is selected
        if (!in_array($isolation_level, self::$available_isolations_levels)) {
            throw new ilAtomQueryException($isolation_level, ilAtomQueryException::DB_ATOM_ISO_WRONG_LEVEL);
        }
    }

References $isolation_level, ilAtomQueryException\DB_ATOM_ISO_WRONG_LEVEL, ilAtomQuery\ISOLATION_READ_COMMITED, ilAtomQuery\ISOLATION_READ_UNCOMMITED, and ilAtomQuery\ISOLATION_REPEATED_READ.

Referenced by ilDatabaseAtomBaseTest\testLevel().

Here is the caller graph for this function:

◆ checkQueries()

ilAtomQueryBase::checkQueries ( )

protected

Exceptions

ilAtomQueryException

Definition at line 256 of file class.ilAtomQueryBase.php.

    {
        if ((is_array($this->query) && 0 === count($this->query)) && !($this->query instanceof \Traversable)) {
            throw new ilAtomQueryException('', ilAtomQueryException::DB_ATOM_CLOSURE_NONE);
        }
 
        foreach ($this->query as $query) {
            if (!$this->checkCallable($query)) {
                throw new ilAtomQueryException('', ilAtomQueryException::DB_ATOM_CLOSURE_WRONG_FORMAT);
            }
        }
    }

References $query, checkCallable(), ilAtomQueryException\DB_ATOM_CLOSURE_NONE, and ilAtomQueryException\DB_ATOM_CLOSURE_WRONG_FORMAT.

Referenced by checkBeforeRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeterminedLockLevel()

ilAtomQueryBase::getDeterminedLockLevel ( )

protected

Returns: int

Definition at line 118 of file class.ilAtomQueryBase.php.

    {
        switch ($this->getIsolationLevel()) {
            case ilAtomQuery::ISOLATION_SERIALIZABLE:
                return ilAtomQuery::LOCK_WRITE;
            // Currently only ISOLATION_SERIALIZABLE is allowed
        }
 
        return ilAtomQuery::LOCK_WRITE;
    }

References getIsolationLevel(), ilAtomQuery\ISOLATION_SERIALIZABLE, and ilAtomQuery\LOCK_WRITE.

Referenced by addTableLock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIsolationLevel()

ilAtomQueryBase::getIsolationLevel ( )

Returns: int

Implements ilAtomQuery.

Definition at line 187 of file class.ilAtomQueryBase.php.

    {
        return $this->isolation_level;
    }

References $isolation_level.

Referenced by checkBeforeRun(), getDeterminedLockLevel(), and getRisks().

Here is the caller graph for this function:

◆ getPossibleAnomalies()

static ilAtomQueryBase::getPossibleAnomalies ( $isolation_level )

static

Parameters

$isolation_level

Returns: array

Definition at line 212 of file class.ilAtomQueryBase.php.

    {
        static::checkIsolationLevel($isolation_level);
 
        return self::$anomalies_map[$isolation_level];
    }

References $isolation_level.

◆ getRisks()

ilAtomQueryBase::getRisks ( )

Returns: array

Definition at line 88 of file class.ilAtomQueryBase.php.

    {
        return static::getPossibleAnomalies($this->getIsolationLevel());
    }

References getIsolationLevel().

Here is the call graph for this function:

◆ isThereRiskThat()

static ilAtomQueryBase::isThereRiskThat	(	$isolation_level,
		$anomaly
	)

static

Parameters

$isolation_level
$anomaly

Returns: bool

Exceptions

ilAtomQueryException

Definition at line 199 of file class.ilAtomQueryBase.php.

    {
        static::checkIsolationLevel($isolation_level);
        static::checkAnomaly($anomaly);
 
        return in_array($anomaly, static::getPossibleAnomalies($isolation_level));
    }

References $isolation_level.

◆ replaceQueryCallable()

ilAtomQueryBase::replaceQueryCallable ( callable $query )

Parameters

callable $query

Exceptions

ilAtomQueryException

Implements ilAtomQuery.

Definition at line 166 of file class.ilAtomQueryBase.php.

    {
        if (!$this->checkCallable($query)) {
            throw new ilAtomQueryException('', ilAtomQueryException::DB_ATOM_CLOSURE_WRONG_FORMAT);
        }
        $this->query = $query;
    }

References $query, checkCallable(), and ilAtomQueryException\DB_ATOM_CLOSURE_WRONG_FORMAT.

Here is the call graph for this function:

◆ run()

ilAtomQueryBase::run ( )

abstract

Fire your Queries.

Exceptions

ilAtomQueryException

Implements ilAtomQuery.

Reimplemented in ilAtomQueryLock, and ilAtomQueryTransaction.

◆ runQueries()

ilAtomQueryBase::runQueries ( )

protected

Exceptions

ilAtomQueryException

Definition at line 337 of file class.ilAtomQueryBase.php.

    {
        $query = $this->query;
        $query($this->ilDBInstance);
    }

References $query.

Referenced by ilAtomQueryLock\runWithLocks(), and ilAtomQueryTransaction\runWithTransactions().

Here is the caller graph for this function:

Field Documentation

◆ $anomalies_map

ilAtomQueryBase::$anomalies_map

staticprotected

Initial value:

= array(
        ilAtomQuery::ISOLATION_READ_UNCOMMITED => array(
            ilAtomQuery::ANO_LOST_UPDATES,
            ilAtomQuery::ANO_DIRTY_READ,
            ilAtomQuery::ANO_NON_REPEATED_READ,
            ilAtomQuery::ANO_PHANTOM,
        ),
        ilAtomQuery::ISOLATION_READ_COMMITED => array(
            ilAtomQuery::ANO_NON_REPEATED_READ,
            ilAtomQuery::ANO_PHANTOM,
        ),
        ilAtomQuery::ISOLATION_REPEATED_READ => array(
            ilAtomQuery::ANO_PHANTOM,
        ),
        ilAtomQuery::ISOLATION_SERIALIZABLE => array(),
    )

Definition at line 35 of file class.ilAtomQueryBase.php.

◆ $available_isolations_levels

ilAtomQueryBase::$available_isolations_levels

staticprotected

Initial value:

= array(
        ilAtomQuery::ISOLATION_READ_UNCOMMITED,
        ilAtomQuery::ISOLATION_READ_COMMITED,
        ilAtomQuery::ISOLATION_REPEATED_READ,
        ilAtomQuery::ISOLATION_SERIALIZABLE,
    )

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

◆ $ilDBInstance

ilAtomQueryBase::$ilDBInstance

protected

Definition at line 66 of file class.ilAtomQueryBase.php.

Referenced by __construct().

◆ $isolation_level

ilAtomQueryBase::$isolation_level = ilAtomQuery::ISOLATION_SERIALIZABLE

protected

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

Referenced by __construct(), checkIsolationLevel(), getIsolationLevel(), getPossibleAnomalies(), and isThereRiskThat().

◆ $possible_anomalies

ilAtomQueryBase::$possible_anomalies

staticprotected

Initial value:

= array(
        ilAtomQuery::ANO_LOST_UPDATES,
        ilAtomQuery::ANO_DIRTY_READ,
        ilAtomQuery::ANO_NON_REPEATED_READ,
        ilAtomQuery::ANO_PHANTOM,
    )

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

◆ $query

ilAtomQueryBase::$query = null

protected

Definition at line 62 of file class.ilAtomQueryBase.php.

Referenced by addQueryCallable(), checkCallable(), checkQueries(), replaceQueryCallable(), and runQueries().

◆ $tables

ilAtomQueryBase::$tables = array()

protected

Definition at line 58 of file class.ilAtomQueryBase.php.

◆ ITERATIONS

const ilAtomQueryBase::ITERATIONS = 10

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

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

Services/Database/classes/Atom/class.ilAtomQueryBase.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addQueryCallable()

◆ addTableLock()

◆ checkAnomaly()

◆ checkBeforeRun()

◆ checkCallable()

◆ checkIsolationLevel()

◆ checkQueries()

◆ getDeterminedLockLevel()

◆ getIsolationLevel()

◆ getPossibleAnomalies()

◆ getRisks()

◆ isThereRiskThat()

◆ replaceQueryCallable()

◆ run()

◆ runQueries()

Field Documentation

◆ $anomalies_map

◆ $available_isolations_levels

◆ $ilDBInstance

◆ $isolation_level

◆ $possible_anomalies

◆ $query

◆ $tables

◆ ITERATIONS