DirectoryCreatedObjective.php

Go to the documentation of this file.

<?php


/* Copyright (c) 2019 Richard Klees <richard.klees@concepts-and-training.de>, Fabian Schmid <fs@studer-raimann.ch> Extended GPL, see docs/LICENSE */

namespace ILIAS\Setup\Objective;

use ILIAS\Setup;

class DirectoryCreatedObjective implements Setup\Objective
{
    const DEFAULT_DIRECTORY_PERMISSIONS = 0755;

    protected $path;

    protected $permissions;

    public function __construct(
        string $path,
        int $permissions = self::DEFAULT_DIRECTORY_PERMISSIONS
    ) {
        if ($path == "") {
            throw new \InvalidArgumentException(
                "Path is empty."
            );
        }
        $this->path = $path;
        $this->permissions = $permissions;
    }

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

    public function getLabel() : string
    {
        return "Create directory '{$this->path}'";
    }

    public function isNotable() : bool
    {
        return true;
    }

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

    public function achieve(Setup\Environment $environment) : Setup\Environment
    {
        mkdir($this->path, $this->permissions);

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

    public function isApplicable(Setup\Environment $environment) : bool
    {
        return !file_exists($this->path);
    }
}