File System Helper, to reduce deps. More...

Collaboration diagram for ilFileSystemHelper:

Public Member Functions
	__construct (ilLanguage $lng, ilSystemStyleMessageStack $message_stack)

	move (string $from, string $to)
	Used to move a complete directory of a skin. More...

	delete (string $file_path)

	saveDeleteFile (string $file_path)
	Deletes a given file in the container. More...

	recursiveRemoveDir (string $dir)
	Recursive delete of a folder. More...

	removeResourceDirectory (string $skin_dir, string $dir)
	Deletes a resource directory. More...

	createResourceDirectory (string $source, string $target)
	Creates a resource directory (sound, images or fonts) by copying from the source (mostly delos) More...

	changeResourceDirectory (string $skin_dir, string $new_dir, string $old_dir)
	Alters the name/path of a resource directory. More...

	recursiveCopy (string $src, string $dest)
	Recursive copy of a folder. More...

	getMessageStack ()

	setMessageStack (ilSystemStyleMessageStack $message_stack)

Protected Attributes
ilSystemStyleMessageStack	$message_stack
	Used to stack messages to be displayed to the user (mostly reports for failed actions) More...

ilLanguage	$lng

Detailed Description

File System Helper, to reduce deps.

to ilUtil or wrap them properly. Should be replaced by src/Filesystem as soon as templates/default is accessible by src/Filesystem

Definition at line 25 of file class.ilFileSystemHelper.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileSystemHelper::__construct	(	ilLanguage	$lng,
		ilSystemStyleMessageStack	$message_stack
	)

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

References $lng, ILIAS\Repository\lng(), and setMessageStack().

     {
         $this->setMessageStack($message_stack);
         $this->lng = $lng;
     }

Here is the call graph for this function:

Member Function Documentation

◆ changeResourceDirectory()

ilFileSystemHelper::changeResourceDirectory	(	string	$skin_dir,
		string	$new_dir,
		string	$old_dir
	)

Alters the name/path of a resource directory.

Exceptions

ilSystemStyleException

Definition at line 129 of file class.ilFileSystemHelper.php.

References getMessageStack(), ILIAS\Repository\lng(), recursiveCopy(), recursiveRemoveDir(), and ilSystemStyleMessage\TYPE_SUCCESS.

                                                                                                : void
     {
         $absolut_new_dir = $skin_dir . $new_dir;
         $absolut_old_dir = $skin_dir . $old_dir;
 
         if (file_exists($absolut_new_dir)) {
             $this->getMessageStack()->addMessage(
                 new ilSystemStyleMessage(
                     $this->lng->txt('dir_changed_to') . ' ' . $absolut_new_dir,
                     ilSystemStyleMessage::TYPE_SUCCESS
                 )
             );
             $this->getMessageStack()->addMessage(
                 new ilSystemStyleMessage(
                     $this->lng->txt('dir_preserved_backup') . ' ' . $absolut_old_dir,
                     ilSystemStyleMessage::TYPE_SUCCESS
                 )
             );
         } else {
             mkdir($absolut_new_dir, 0775, true);
             $this->recursiveCopy($absolut_old_dir, $absolut_new_dir);
             $this->getMessageStack()->addMessage(
                 new ilSystemStyleMessage(
                     $this->lng->txt('dir_copied_from') . ' ' . $absolut_old_dir . ' ' . $this->lng->txt('sty_copy_to') . ' ' . $absolut_new_dir,
                     ilSystemStyleMessage::TYPE_SUCCESS
                 )
             );
             $this->recursiveRemoveDir($skin_dir . $old_dir);
             $this->getMessageStack()->addMessage(
                 new ilSystemStyleMessage(
                     $this->lng->txt('dir_deleted') . ' ' . $absolut_old_dir,
                     ilSystemStyleMessage::TYPE_SUCCESS
                 )
             );
         }
     }

Here is the call graph for this function:

◆ createResourceDirectory()

ilFileSystemHelper::createResourceDirectory	(	string	$source,
		string	$target
	)

Creates a resource directory (sound, images or fonts) by copying from the source (mostly delos)

Exceptions

ilSystemStyleException

Definition at line 110 of file class.ilFileSystemHelper.php.

References getMessageStack(), ILIAS\Repository\lng(), recursiveCopy(), and ilSystemStyleMessage\TYPE_SUCCESS.

                                                                            : void
     {
         mkdir($target, 0775, true);
 
         if ($source != '') {
             $this->recursiveCopy($source, $target);
             $this->getMessageStack()->addMessage(
                 new ilSystemStyleMessage(
                     $this->lng->txt('dir_created') . $target,
                     ilSystemStyleMessage::TYPE_SUCCESS
                 )
             );
         }
     }

Here is the call graph for this function:

◆ delete()

ilFileSystemHelper::delete ( string $file_path )

Definition at line 47 of file class.ilFileSystemHelper.php.

                                              : void
     {
         unlink($file_path);
     }

◆ getMessageStack()

ilFileSystemHelper::getMessageStack ( )

Definition at line 207 of file class.ilFileSystemHelper.php.

References $message_stack.

Referenced by changeResourceDirectory(), createResourceDirectory(), removeResourceDirectory(), and saveDeleteFile().

                                      : ilSystemStyleMessageStack
     {
         return $this->message_stack;
     }

Here is the caller graph for this function:

◆ move()

ilFileSystemHelper::move	(	string	$from,
		string	$to
	)

Used to move a complete directory of a skin.

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

                                                   : void
     {
         rename($from, $to);
     }

◆ recursiveCopy()

ilFileSystemHelper::recursiveCopy	(	string	$src,
		string	$dest
	)

Recursive copy of a folder.

Exceptions

ilSystemStyleException

Definition at line 170 of file class.ilFileSystemHelper.php.

References Vendor\Package\$e, ilSystemStyleException\FILE_CREATION_FAILED, ilSystemStyleException\FILE_OPENING_FAILED, and ilSystemStyleException\FOLDER_CREATION_FAILED.

Referenced by changeResourceDirectory(), ilSkinFactory\copyFromSkinStyleContainer(), and createResourceDirectory().

                                                             : void
     {
         foreach (scandir($src) as $file) {
             $src_file = rtrim($src, '/') . '/' . $file;
             $dest_file = rtrim($dest, '/') . '/' . $file;
             if (!is_readable($src_file)) {
                 throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $src_file);
             }
             if (substr($file, 0, 1) != '.') {
                 if (is_dir($src_file)) {
                     if (!file_exists($dest_file)) {
                         try {
                             mkdir($dest_file);
                         } catch (Exception $e) {
                             throw new ilSystemStyleException(
                                 ilSystemStyleException::FOLDER_CREATION_FAILED,
                                 'Copy ' . $src_file . ' to ' . $dest_file . ' Error: ' . $e
                             );
                         }
                     }
                     $this->recursiveCopy($src_file, $dest_file);
                 } else {
                     try {
                         copy($src_file, $dest_file);
                     } catch (Exception $e) {
                         throw new ilSystemStyleException(
                             ilSystemStyleException::FILE_CREATION_FAILED,
                             'Copy ' . $src_file . ' to ' . $dest_file . ' Error: ' . $e
                         );
                     }
                 }
             }
         }
     }

Here is the caller graph for this function:

◆ recursiveRemoveDir()

ilFileSystemHelper::recursiveRemoveDir ( string $dir )

Recursive delete of a folder.

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

Referenced by changeResourceDirectory().

                                                    : void
     {
         if (is_dir($dir)) {
             $objects = scandir($dir);
             foreach ($objects as $object) {
                 if ($object != '.' && $object != '..') {
                     if (is_dir($dir . '/' . $object)) {
                         $this->recursiveRemoveDir($dir . '/' . $object);
                     } else {
                         unlink($dir . '/' . $object);
                     }
                 }
             }
             rmdir($dir);
         }
     }

Here is the caller graph for this function:

◆ removeResourceDirectory()

ilFileSystemHelper::removeResourceDirectory	(	string	$skin_dir,
		string	$dir
	)

Deletes a resource directory.

Definition at line 91 of file class.ilFileSystemHelper.php.

References getMessageStack(), ILIAS\Repository\lng(), and ilSystemStyleMessage\TYPE_SUCCESS.

     {
         $absolut_dir = $skin_dir . $dir;
 
         if (file_exists($absolut_dir)) {
             self::recursiveRemoveDir($absolut_dir);
             $this->getMessageStack()->addMessage(
                 new ilSystemStyleMessage(
                     $this->lng->txt('dir_deleted') . ' ' . $dir,
                     ilSystemStyleMessage::TYPE_SUCCESS
                 )
             );
         }
     }

Here is the call graph for this function:

◆ saveDeleteFile()

ilFileSystemHelper::saveDeleteFile ( string $file_path )

Deletes a given file in the container.

Definition at line 55 of file class.ilFileSystemHelper.php.

References getMessageStack(), ILIAS\Repository\lng(), and ilSystemStyleMessage\TYPE_SUCCESS.

                                                      : void
     {
         if (file_exists($file_path)) {
             unlink($file_path);
             $this->getMessageStack()->addMessage(
                 new ilSystemStyleMessage(
                     $this->lng->txt('file_deleted') . ' ' . $file_path,
                     ilSystemStyleMessage::TYPE_SUCCESS
                 )
             );
         }
     }

Here is the call graph for this function:

◆ setMessageStack()

ilFileSystemHelper::setMessageStack ( ilSystemStyleMessageStack $message_stack )

Definition at line 212 of file class.ilFileSystemHelper.php.

References $message_stack.

Referenced by __construct().

                                                                              : void
     {
         $this->message_stack = $message_stack;
     }

Here is the caller graph for this function:

Field Documentation

◆ $lng

ilLanguage ilFileSystemHelper::$lng

protected

Definition at line 31 of file class.ilFileSystemHelper.php.

Referenced by __construct().

◆ $message_stack

ilSystemStyleMessageStack ilFileSystemHelper::$message_stack

protected

Used to stack messages to be displayed to the user (mostly reports for failed actions)

Definition at line 30 of file class.ilFileSystemHelper.php.

Referenced by getMessageStack(), and setMessageStack().

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

Services/Style/System/classes/Utilities/class.ilFileSystemHelper.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ changeResourceDirectory()

◆ createResourceDirectory()

◆ delete()

◆ getMessageStack()

◆ move()

◆ recursiveCopy()

◆ recursiveRemoveDir()

◆ removeResourceDirectory()

◆ saveDeleteFile()

◆ setMessageStack()

Field Documentation

◆ $lng

◆ $message_stack