ILIAS\Setup\Objective\DirectoryCreatedObjective Class Reference

Create a directory. More...

Inheritance diagram for ILIAS\Setup\Objective\DirectoryCreatedObjective:

Collaboration diagram for ILIAS\Setup\Objective\DirectoryCreatedObjective:

Public Member Functions
	__construct (string $path, int $permissions=self::DEFAULT_DIRECTORY_PERMISSIONS)
	getHash ()
	Uses hashed Path. More...
	getLabel ()
	Defaults to "Build $this->getArtifactPath()". More...
	isNotable ()
	Defaults to 'true'. More...
	getPreconditions (Setup\Environment $environment)
	@inheritdocs More...
	achieve (Setup\Environment $environment)
	@inheritdocs More...
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\Setup\Objective
	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...

Data Fields
const	DEFAULT_DIRECTORY_PERMISSIONS = 0755

Protected Attributes
string	$path
int	$permissions

Detailed Description

Create a directory.

Definition at line 28 of file DirectoryCreatedObjective.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\Objective\DirectoryCreatedObjective::__construct	(	string	$path,
		int	$permissions = self::DEFAULT_DIRECTORY_PERMISSIONS
	)

Definition at line 35 of file DirectoryCreatedObjective.php.

      {
        if ($path == "") {
            throw new \InvalidArgumentException(
                "Path is empty."
            );
        }
        $this->path = $path;
        $this->permissions = $permissions;
    }

References ILIAS\Setup\Objective\DirectoryCreatedObjective\$path, and ILIAS\Setup\Objective\DirectoryCreatedObjective\$permissions.

Member Function Documentation

achieve()

ILIAS\Setup\Objective\DirectoryCreatedObjective::achieve

(

Setup\Environment

$environment

)

@inheritdocs

Definition at line 94 of file DirectoryCreatedObjective.php.

                                                           : Setup\Environment
    {
        @mkdir($this->path, $this->permissions);
 
        if (!is_dir($this->path)) {
            throw new Setup\UnachievableException(
                "Could not create directory '$this->path'"
            );
        }
        return $environment;
    }

getHash()

ILIAS\Setup\Objective\DirectoryCreatedObjective::getHash

(

)

Uses hashed Path.

@inheritdocs

Implements ILIAS\Setup\Objective.

Reimplemented in ilFileSystemComponentDataDirectoryCreatedObjective.

Definition at line 53 of file DirectoryCreatedObjective.php.

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

getLabel()

ILIAS\Setup\Objective\DirectoryCreatedObjective::getLabel

(

)

Defaults to "Build $this->getArtifactPath()".

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 63 of file DirectoryCreatedObjective.php.

                              : string
    {
        return "Create directory '$this->path'";
    }

getPreconditions()

ILIAS\Setup\Objective\DirectoryCreatedObjective::getPreconditions

(

Setup\Environment

$environment

)

@inheritdocs

Definition at line 81 of file DirectoryCreatedObjective.php.

                                                                    : array
    {
        if (file_exists($this->path)) {
            return [];
        }
        return [
            new Setup\Condition\CanCreateDirectoriesInDirectoryCondition(dirname($this->path))
        ];
    }

isApplicable()

ILIAS\Setup\Objective\DirectoryCreatedObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 109 of file DirectoryCreatedObjective.php.

                                                                : bool
    {
        return !file_exists($this->path);
    }

isNotable()

ILIAS\Setup\Objective\DirectoryCreatedObjective::isNotable

(

)

Defaults to 'true'.

@inheritdocs

Implements ILIAS\Setup\Objective.

Definition at line 73 of file DirectoryCreatedObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

$path

string ILIAS\Setup\Objective\DirectoryCreatedObjective::$path

protected

Definition at line 32 of file DirectoryCreatedObjective.php.

Referenced by ILIAS\Setup\Objective\DirectoryCreatedObjective\__construct().

$permissions

int ILIAS\Setup\Objective\DirectoryCreatedObjective::$permissions

protected

Definition at line 33 of file DirectoryCreatedObjective.php.

Referenced by ILIAS\Setup\Objective\DirectoryCreatedObjective\__construct().

DEFAULT_DIRECTORY_PERMISSIONS

const ILIAS\Setup\Objective\DirectoryCreatedObjective::DEFAULT_DIRECTORY_PERMISSIONS = 0755

Definition at line 30 of file DirectoryCreatedObjective.php.

---

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

• components/ILIAS/Setup/src/Objective/DirectoryCreatedObjective.php