ilAtomQueryBase 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 ilAtomQueryBase:

Collaboration diagram for ilAtomQueryBase:

Public Member Functions
	__construct (ilDBInterface $ilDBInstance, int $isolation_level=ilAtomQuery::ISOLATION_SERIALIZABLE)
	ilAtomQuery constructor. More...
	getRisks ()
	addTableLock (string $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)

Static Public Member Functions
static	isThereRiskThat (int $isolation_level, int $anomaly)
static	getPossibleAnomalies (int $isolation_level)
static	checkIsolationLevel (int $isolation_level)
static	checkAnomaly (int $anomaly)

Protected Member Functions
	getDeterminedLockLevel ()
	checkQueries ()
	hasWriteLocks ()
	runQueries ()
	checkBeforeRun ()

Protected Attributes
const	ITERATIONS = 10
int	$isolation_level = ilAtomQuery::ISOLATION_SERIALIZABLE
array	$tables = array()
	$query
ilDBInterface	$ilDBInstance

Static Protected Attributes
static array	$available_isolations_levels
static array	$possible_anomalies
static array	$anomalies_map

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 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 27 of file class.ilAtomQueryBase.php.

Constructor & Destructor Documentation

__construct()

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

ilAtomQuery constructor.

Parameters

int

$isolation_level

currently only ISOLATION_SERIALIZABLE is available

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

References $ilDBInstance, and $isolation_level.

    {
        static::checkIsolationLevel($isolation_level);
        $this->ilDBInstance = $ilDBInstance;
        $this->isolation_level = $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());

Exceptions

ilAtomQueryException

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

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

                                                     : void
    {
        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;
    }

Here is the call graph for this function:

addTableLock()

ilAtomQueryBase::addTableLock

(

string

$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

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

References getDeterminedLockLevel().

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

        return $ilTableLock;
    }

Here is the call graph for this function:

checkAnomaly()

static ilAtomQueryBase::checkAnomaly ( int  $anomaly )

static

Exceptions

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

References ilAtomQueryException\DB_ATOM_ANO_NOT_AVAILABLE.

                                                     : void
    {
        if (!in_array($anomaly, self::$possible_anomalies)) {
            throw new ilAtomQueryException('Anomaly: ' . $anomaly, ilAtomQueryException::DB_ATOM_ANO_NOT_AVAILABLE);
        }
    }

checkBeforeRun()

ilAtomQueryBase::checkBeforeRun ( )

protected

Exceptions

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

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

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

                                       : void
    {
        $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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkCallable()

ilAtomQueryBase::checkCallable

(

callable

$query

)

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

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

                                                  : bool
    {
        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;
        }

        $is_a_closure = ($query instanceof 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]->getType();
            return $reflectionClass && $reflectionClass->getName() === ilDBInterface::class;
        }

        return true;
    }

Here is the caller graph for this function:

checkIsolationLevel()

static ilAtomQueryBase::checkIsolationLevel ( int  $isolation_level )

static

Exceptions

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

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

                                                                    : void
    {
        // 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('Level: ' . $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('Level: ' . $isolation_level, ilAtomQueryException::DB_ATOM_ISO_WRONG_LEVEL);
        }
    }

checkQueries()

ilAtomQueryBase::checkQueries ( )

protected

Exceptions

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

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

Referenced by checkBeforeRun().

                                     : void
    {
        if (!($this->query instanceof \Traversable) && (is_array($this->query) && 0 === count($this->query))) {
            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);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDeterminedLockLevel()

ilAtomQueryBase::getDeterminedLockLevel ( )

protected

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

References ilAtomQuery\LOCK_WRITE.

Referenced by addTableLock().

                                               : int
    {
        return ilAtomQuery::LOCK_WRITE;
    }

Here is the caller graph for this function:

getIsolationLevel()

ilAtomQueryBase::getIsolationLevel

(

)

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

References $isolation_level.

Referenced by checkBeforeRun(), and getRisks().

                                       : int
    {
        return $this->isolation_level;
    }

Here is the caller graph for this function:

getPossibleAnomalies()

static ilAtomQueryBase::getPossibleAnomalies ( int  $isolation_level )

static

Returns

int[]

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

References $isolation_level.

                                                                     : array
    {
        static::checkIsolationLevel($isolation_level);

        return self::$anomalies_map[$isolation_level];
    }

getRisks()

ilAtomQueryBase::getRisks

(

)

Returns

int[]

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

References getIsolationLevel().

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

Here is the call graph for this function:

hasWriteLocks()

ilAtomQueryBase::hasWriteLocks ( )

protected

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

References ilAtomQuery\LOCK_WRITE.

Referenced by checkBeforeRun().

                                      : bool
    {
        $has_write_locks = false;
        foreach ($this->tables as $table) {
            if ($table->getLockLevel() === ilAtomQuery::LOCK_WRITE) {
                $has_write_locks = true;
            }
        }

        return $has_write_locks;
    }

Here is the caller graph for this function:

isThereRiskThat()

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

static

Exceptions

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

                                                                              : bool
    {
        static::checkIsolationLevel($isolation_level);
        static::checkAnomaly($anomaly);

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

replaceQueryCallable()

ilAtomQueryBase::replaceQueryCallable

(

callable

$query

)

Exceptions

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

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

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

Here is the call graph for this function:

run()

ilAtomQueryBase::run ( )

abstract

Fire your Queries.

Exceptions

Referenced by replaceQueryCallable().

Here is the caller graph for this function:

runQueries()

ilAtomQueryBase::runQueries ( )

protected

Exceptions

ilAtomQueryException

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

References $query.

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

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

Here is the caller graph for this function:

Field Documentation

$anomalies_map

array 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 51 of file class.ilAtomQueryBase.php.

$available_isolations_levels

array 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 33 of file class.ilAtomQueryBase.php.

$ilDBInstance

ilDBInterface ilAtomQueryBase::$ilDBInstance

protected

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

Referenced by __construct().

$isolation_level

int ilAtomQueryBase::$isolation_level = ilAtomQuery::ISOLATION_SERIALIZABLE

protected

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

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

$possible_anomalies

array 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 42 of file class.ilAtomQueryBase.php.

$query

ilAtomQueryBase::$query

protected

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

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

$tables

array ilAtomQueryBase::$tables = array()

protected

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

ITERATIONS

const ilAtomQueryBase::ITERATIONS = 10

protected

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

---

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

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