ilFileSystemComponentDataDirectoryCreatedObjective Class Reference

Inheritance diagram for ilFileSystemComponentDataDirectoryCreatedObjective:

Collaboration diagram for ilFileSystemComponentDataDirectoryCreatedObjective:

Public Member Functions
	__construct (string $component_dir, int $base_location=self::DATADIR, int $permissions=self::DEFAULT_DIRECTORY_PERMISSIONS)
	getHash ()
	@inheritdocs More...
	getLabel ()
	@inheritdocs More...
	isNotable ()
	@inheritdocs More...
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)

Data Fields
const	DATADIR = 1
const	WEBDIR = 2
const	DEFAULT_DIRECTORY_PERMISSIONS = 0755

Protected Member Functions
	buildPath (Setup\Environment $environment)

Protected Attributes
	$component_dir
	$base_location
	$permissions

Detailed Description

Definition at line 8 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

Constructor & Destructor Documentation

__construct()

ilFileSystemComponentDataDirectoryCreatedObjective::__construct	(	string	$component_dir,
		int	$base_location = self::DATADIR,
		int	$permissions = self::DEFAULT_DIRECTORY_PERMISSIONS
	)

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

      {
        $this->component_dir = $component_dir;
        $this->base_location = $base_location;
        $this->permissions = $permissions;
    }

References $base_location, $component_dir, and $permissions.

Member Function Documentation

achieve()

ilFileSystemComponentDataDirectoryCreatedObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 79 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

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

References buildPath().

Here is the call graph for this function:

buildPath()

ilFileSystemComponentDataDirectoryCreatedObjective::buildPath ( Setup\Environment  $environment )

protected

Definition at line 94 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

                                                                 : string
    {
        $common_config = $environment->getConfigFor("common");
        $fs_config = $environment->getConfigFor("filesystem");
 
        if ($this->base_location === self::DATADIR) {
            $data_dir = $fs_config->getDataDir();
        }
 
        if ($this->base_location === self::WEBDIR) {
            $data_dir = $fs_config->getWebDir();
        }
 
        $client_data_dir = $data_dir . '/' . $common_config->getClientId();
        $new_dir = $client_data_dir . '/' . $this->component_dir;
 
        return $new_dir;
    }

References $component_dir.

Referenced by achieve().

Here is the caller graph for this function:

getHash()

ilFileSystemComponentDataDirectoryCreatedObjective::getHash

(

)

@inheritdocs

Definition at line 42 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

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

getLabel()

ilFileSystemComponentDataDirectoryCreatedObjective::getLabel

(

)

@inheritdocs

Definition at line 50 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

                               : string
    {
        $dir = '';
        if ($this->base_location === self::DATADIR) {
            $dir = 'data';
        }
        if ($this->base_location === self::WEBDIR) {
            $dir = 'web';
        }
 
        return "Create $dir directory in component directory $this->component_dir";
    }

getPreconditions()

ilFileSystemComponentDataDirectoryCreatedObjective::getPreconditions

(

Setup\Environment

$environment

)

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

                                                                     : array
    {
        $config = $environment->getConfigFor("filesystem");
        return [
            new ilFileSystemDirectoriesCreatedObjective($config)
        ];
    }

References $config.

isNotable()

ilFileSystemComponentDataDirectoryCreatedObjective::isNotable

(

)

@inheritdocs

Definition at line 66 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

                                : bool
    {
        return true;
    }

Field Documentation

$base_location

ilFileSystemComponentDataDirectoryCreatedObjective::$base_location

protected

Definition at line 22 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

Referenced by __construct().

$component_dir

ilFileSystemComponentDataDirectoryCreatedObjective::$component_dir

protected

Definition at line 17 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

Referenced by __construct(), and buildPath().

$permissions

ilFileSystemComponentDataDirectoryCreatedObjective::$permissions

protected

Definition at line 27 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

Referenced by __construct().

DATADIR

const ilFileSystemComponentDataDirectoryCreatedObjective::DATADIR = 1

Definition at line 10 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

Referenced by ilForumSetupAgent\getInstallObjective(), and ilMailSetupAgent\getInstallObjective().

DEFAULT_DIRECTORY_PERMISSIONS

const ilFileSystemComponentDataDirectoryCreatedObjective::DEFAULT_DIRECTORY_PERMISSIONS = 0755

Definition at line 12 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

WEBDIR

const ilFileSystemComponentDataDirectoryCreatedObjective::WEBDIR = 2

Definition at line 11 of file class.ilFileSystemComponentDataDirectoryCreatedObjective.php.

Referenced by ilLearningModuleSetupAgent\getInstallObjective(), ilLearningSequenceSetupAgent\getInstallObjective(), ilMediaObjectSetupAgent\getInstallObjective(), and ilUserSetupAgent\getInstallObjective().

---

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

• Services/FileSystem/classes/Setup/class.ilFileSystemComponentDataDirectoryCreatedObjective.php