ilDatabaseDumpedToDirectoryObjective Class Reference

Inheritance diagram for ilDatabaseDumpedToDirectoryObjective:

Collaboration diagram for ilDatabaseDumpedToDirectoryObjective:

Public Member Functions
	__construct (protected string $target, protected MysqlDumper $dumper)
	getHash ()
	Get a hash for this objective.The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. Exceptions UnachievableException if the objective is not achievable Returns Objective[] More...
	achieve (Environment $environment)
	Objectives can be achieved.They might add resources to the environment when they have been achieved.This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called. Exceptions LogicException if there are unfullfilled preconditions. Exceptions RuntimeException if there are missing resources. More...
	isApplicable (Environment $environment)
	@inheritDoc More...
	getHash ()
	Get a hash for this objective. More...
	getLabel ()
	Get a label that describes this objective. More...
	isNotable ()
	Get to know if this is an interesting objective for a human. More...
	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...
	achieve (Environment $environment)
	Objectives can be achieved. More...
	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Protected Member Functions
	deleteDirRecursive (string $path)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDatabaseDumpedToDirectoryObjective::__construct	(	protected string	$target,
		protected MysqlDumper	$dumper
	)

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

    {
    }

Member Function Documentation

achieve()

ilDatabaseDumpedToDirectoryObjective::achieve

(

Environment

$environment

)

Objectives can be achieved.They might add resources to the environment when they have been achieved.This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

LogicException if there are unfullfilled preconditions.

Exceptions

RuntimeException if there are missing resources.

Implements ILIAS\Setup\Objective.

Definition at line 68 of file class.ilDatabaseDumpedToDirectoryObjective.php.

                                                     : Environment
    {
        if (file_exists($this->target)) {
            $this->deleteDirRecursive($this->target);
        }
        mkdir($this->target, 0755);
 
        $client_ini = $environment->getResource(Environment::RESOURCE_CLIENT_INI);
        $host = $client_ini->readVariable("db", "host");
        $user = $client_ini->readVariable("db", "user");
        $password = $client_ini->readVariable("db", "pass");
        $name = $client_ini->readVariable("db", "name");
        $port = $client_ini->readVariable("db", "port");
 
        $this->dumper->createDump($host, $user, $password, $name, $port, $this->target);
 
        return $environment;
    }

References deleteDirRecursive(), and ILIAS\Setup\Environment\getResource().

Here is the call graph for this function:

deleteDirRecursive()

ilDatabaseDumpedToDirectoryObjective::deleteDirRecursive ( string  $path )

protected

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

                                                       : void
    {
        $files = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
            RecursiveIteratorIterator::CHILD_FIRST
        );
 
        foreach ($files as $file_info) {
            if ($file_info->isDir()) {
                rmdir($file_info->getRealPath());
                continue;
            }
            unlink($file_info->getRealPath());
        }
 
        rmdir($path);
    }

References $path.

Referenced by achieve().

Here is the caller graph for this function:

getHash()

ilDatabaseDumpedToDirectoryObjective::getHash

(

)

Get a hash for this objective.The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Implements ILIAS\Setup\Objective.

Definition at line 33 of file class.ilDatabaseDumpedToDirectoryObjective.php.

                             : string
    {
        return hash("sha256", self::class . $this->target);
    }

getLabel()

ilDatabaseDumpedToDirectoryObjective::getLabel

(

)

Get a label that describes this objective.

Implements ILIAS\Setup\Objective.

Definition at line 41 of file class.ilDatabaseDumpedToDirectoryObjective.php.

                              : string
    {
        return "Dump database to $this->target/" . MysqlIfsnopDumper::FILE_NAME;
    }

References MysqlIfsnopDumper\FILE_NAME.

getPreconditions()

ilDatabaseDumpedToDirectoryObjective::getPreconditions

(

Environment

$environment

)

Objectives might depend on other objectives.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 57 of file class.ilDatabaseDumpedToDirectoryObjective.php.

                                                              : array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new ilDatabaseInitializedObjective(),
        ];
    }

isApplicable()

ilDatabaseDumpedToDirectoryObjective::isApplicable

(

Environment

$environment

)

@inheritDoc

Implements ILIAS\Setup\Objective.

Definition at line 90 of file class.ilDatabaseDumpedToDirectoryObjective.php.

                                                          : bool
    {
        return is_writable(pathinfo($this->target, PATHINFO_DIRNAME));
    }

isNotable()

ilDatabaseDumpedToDirectoryObjective::isNotable

(

)

Get to know if this is an interesting objective for a human.

Implements ILIAS\Setup\Objective.

Definition at line 49 of file class.ilDatabaseDumpedToDirectoryObjective.php.

                               : bool
    {
        return true;
    }

---

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

• components/ILIAS/Database/classes/Setup/class.ilDatabaseDumpedToDirectoryObjective.php