ILIAS\Setup\Metrics Namespace Reference

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

Data Structures
class	ArrayStorage
class	CollectedObjective
	Base class to simplify collection of metrics. More...
class	Metric
	A metric is something we can measure about the system. More...
interface	Storage
class	StorageOnPathWrapper

Functions
	storeConfigBool (string $key, bool $value, string $description=null)
	storeConfigCounter (string $key, int $value, string $description=null)
	storeConfigGauge (string $key, $value, string $description=null)
	storeConfigTimestamp (string $key, \DateTimeImmutable $value, string $description=null)
	storeConfigText (string $key, string $value, string $description=null)
	storeStableBool (string $key, bool $value, string $description=null)
	storeStableCounter (string $key, int $value, string $description=null)
	storeStableGauge (string $key, $value, string $description=null)
	storeStableTimestamp (string $key, \DateTimeImmutable $value, string $description=null)
	storeStableText (string $key, string $value, string $description=null)
	storeVolatileBool (string $key, bool $value, string $description=null)
	storeVolatileCounter (string $key, int $value, string $description=null)
	storeVolatileGauge (string $key, $value, string $description=null)
	storeVolatileTimestamp (string $key, \DateTimeImmutable $value, string $description=null)
	storeVolatileText (string $key, string $value, string $description=null)

Variables
trait	StorageConvenience
	Implements the convenience methods of Storage over Storage::store. More...

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

Function Documentation

storeConfigBool()

ILIAS\Setup\Metrics\storeConfigBool	(	string	$key,
		bool	$value,
		string	$description = null
	)

Definition at line 32 of file StorageConvenience.php.

                                                                                         : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_CONFIG, M::TYPE_BOOL, $value, $description)
        );
    }

storeConfigCounter()

ILIAS\Setup\Metrics\storeConfigCounter	(	string	$key,
		int	$value,
		string	$description = null
	)

Definition at line 40 of file StorageConvenience.php.

                                                                                           : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_CONFIG, M::TYPE_COUNTER, $value, $description)
        );
    }

storeConfigGauge()

ILIAS\Setup\Metrics\storeConfigGauge	(	string	$key,
			$value,
		string	$description = null
	)

Definition at line 48 of file StorageConvenience.php.

                                                                                     : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_CONFIG, M::TYPE_GAUGE, $value, $description)
        );
    }

storeConfigText()

ILIAS\Setup\Metrics\storeConfigText	(	string	$key,
		string	$value,
		string	$description = null
	)

Definition at line 64 of file StorageConvenience.php.

                                                                                           : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_CONFIG, M::TYPE_TEXT, $value, $description)
        );
    }

storeConfigTimestamp()

ILIAS\Setup\Metrics\storeConfigTimestamp	(	string	$key,
		\DateTimeImmutable	$value,
		string	$description = null
	)

Definition at line 56 of file StorageConvenience.php.

                                                                                                            : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_CONFIG, M::TYPE_TIMESTAMP, $value, $description)
        );
    }

storeStableBool()

ILIAS\Setup\Metrics\storeStableBool	(	string	$key,
		bool	$value,
		string	$description = null
	)

Definition at line 73 of file StorageConvenience.php.

                                                                                         : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_STABLE, M::TYPE_BOOL, $value, $description)
        );
    }

storeStableCounter()

ILIAS\Setup\Metrics\storeStableCounter	(	string	$key,
		int	$value,
		string	$description = null
	)

Definition at line 81 of file StorageConvenience.php.

                                                                                           : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_STABLE, M::TYPE_COUNTER, $value, $description)
        );
    }

storeStableGauge()

ILIAS\Setup\Metrics\storeStableGauge	(	string	$key,
			$value,
		string	$description = null
	)

Definition at line 89 of file StorageConvenience.php.

                                                                                     : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_STABLE, M::TYPE_GAUGE, $value, $description)
        );
    }

storeStableText()

ILIAS\Setup\Metrics\storeStableText	(	string	$key,
		string	$value,
		string	$description = null
	)

Definition at line 105 of file StorageConvenience.php.

                                                                                           : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_STABLE, M::TYPE_TEXT, $value, $description)
        );
    }

storeStableTimestamp()

ILIAS\Setup\Metrics\storeStableTimestamp	(	string	$key,
		\DateTimeImmutable	$value,
		string	$description = null
	)

Definition at line 97 of file StorageConvenience.php.

                                                                                                            : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_STABLE, M::TYPE_TIMESTAMP, $value, $description)
        );
    }

storeVolatileBool()

ILIAS\Setup\Metrics\storeVolatileBool	(	string	$key,
		bool	$value,
		string	$description = null
	)

Definition at line 114 of file StorageConvenience.php.

                                                                                           : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_VOLATILE, M::TYPE_BOOL, $value, $description)
        );
    }

storeVolatileCounter()

ILIAS\Setup\Metrics\storeVolatileCounter	(	string	$key,
		int	$value,
		string	$description = null
	)

Definition at line 122 of file StorageConvenience.php.

                                                                                             : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_VOLATILE, M::TYPE_COUNTER, $value, $description)
        );
    }

storeVolatileGauge()

ILIAS\Setup\Metrics\storeVolatileGauge	(	string	$key,
			$value,
		string	$description = null
	)

Definition at line 130 of file StorageConvenience.php.

                                                                                       : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_VOLATILE, M::TYPE_GAUGE, $value, $description)
        );
    }

storeVolatileText()

ILIAS\Setup\Metrics\storeVolatileText	(	string	$key,
		string	$value,
		string	$description = null
	)

Definition at line 146 of file StorageConvenience.php.

                                                                                             : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_VOLATILE, M::TYPE_TEXT, $value, $description)
        );
    }

storeVolatileTimestamp()

ILIAS\Setup\Metrics\storeVolatileTimestamp	(	string	$key,
		\DateTimeImmutable	$value,
		string	$description = null
	)

Definition at line 138 of file StorageConvenience.php.

                                                                                                              : void
    {
        $this->store(
            $key,
            new M(M::STABILITY_VOLATILE, M::TYPE_TIMESTAMP, $value, $description)
        );
    }

Variable Documentation

StorageConvenience

trait ILIAS::Setup::Metrics\StorageConvenience

Initial value:

{
    abstract public function store(string $key, M $metric): void

Implements the convenience methods of Storage over Storage::store.

Definition at line 29 of file StorageConvenience.php.