Inheritance diagram for ilStyleReplaceResponsiveLogoObjective:

Collaboration diagram for ilStyleReplaceResponsiveLogoObjective:

Public Member Functions
	__construct ()

	getHash ()

	getLabel ()

	isNotable ()

	getPreconditions (Environment $environment)

	achieve (Environment $environment)

Protected Member Functions
	maybeReplaceResponsiveIcon (string $skin_path)
	Replaces the responsive header-icon with the common header-icon, if the common icon is different from the ilias icon but the responsive icon is not. More...

	getFileHash (string $absolute_file_path)
	Returns the sha1-sum of the given file if it exists. More...

Protected Attributes
const	RESPONSIVE_LOGO_PATH = '/images/HeaderIconResponsive.svg'

const	COMMON_LOGO_PATH = '/images/HeaderIcon.svg'

	$delos_responsive_logo_hash

	$delos_common_logo_hash

	$delos_path

	$ilias_path

Detailed Description

Author: Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns AutoloadingIssuesInspection

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

Constructor & Destructor Documentation

◆ __construct()

ilStyleReplaceResponsiveLogoObjective::__construct ( )

Definition at line 34 of file class.ilStyleReplaceResponsiveLogoObjective.php.

References getFileHash().

     {
         // determine ilias and delos-skin paths.
         $this->ilias_path = dirname(__FILE__, 5);
         $this->delos_path = "$this->ilias_path/templates/default/";
 
         // calculate original logo hashes.
         $this->delos_responsive_logo_hash = $this->getFileHash($this->delos_path . self::RESPONSIVE_LOGO_PATH);
         $this->delos_common_logo_hash = $this->getFileHash($this->delos_path . self::COMMON_LOGO_PATH);
     }

Here is the call graph for this function:

Member Function Documentation

◆ achieve()

ilStyleReplaceResponsiveLogoObjective::achieve ( Environment $environment )

Implements ILIAS\Setup\Objective.

Definition at line 80 of file class.ilStyleReplaceResponsiveLogoObjective.php.

References maybeReplaceResponsiveIcon().

                                                       : Environment
     {
         // abort if the header-icons of the delos skin could not be located.
         if (null === $this->delos_common_logo_hash || null === $this->delos_responsive_logo_hash) {
             return $environment;
         }
 
         $skin_directory = "$this->ilias_path/Customizing/global/skin/";
 
         // nothing to do if no custom skins were installed/created.
         if (!file_exists($skin_directory) || !is_dir($skin_directory)) {
             return $environment;
         }
 
         foreach (new DirectoryIterator($skin_directory) as $skin_name) {
             if ('.' === $skin_name || '..' === $skin_name) {
                 continue;
             }
 
             $this->maybeReplaceResponsiveIcon($skin_directory . $skin_name);
         }
 
         return $environment;
     }

Here is the call graph for this function:

◆ getFileHash()

ilStyleReplaceResponsiveLogoObjective::getFileHash ( string $absolute_file_path )

protected

Returns the sha1-sum of the given file if it exists.

Definition at line 124 of file class.ilStyleReplaceResponsiveLogoObjective.php.

Referenced by __construct(), and maybeReplaceResponsiveIcon().

                                                                : ?string
     {
         if (!file_exists($absolute_file_path)) {
             return null;
         }
 
         if (false !== ($hash = sha1_file($absolute_file_path))) {
             return $hash;
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ getHash()

ilStyleReplaceResponsiveLogoObjective::getHash ( )

Implements ILIAS\Setup\Objective.

Definition at line 48 of file class.ilStyleReplaceResponsiveLogoObjective.php.

                               : string
     {
         return hash("sha256", self::class);
     }

◆ getLabel()

ilStyleReplaceResponsiveLogoObjective::getLabel ( )

Implements ILIAS\Setup\Objective.

Definition at line 56 of file class.ilStyleReplaceResponsiveLogoObjective.php.

                                : string
     {
         return 'Replacing responsive logos where necessary.';
     }

◆ getPreconditions()

ilStyleReplaceResponsiveLogoObjective::getPreconditions ( Environment $environment )

Implements ILIAS\Setup\Objective.

Definition at line 72 of file class.ilStyleReplaceResponsiveLogoObjective.php.

◆ isNotable()

ilStyleReplaceResponsiveLogoObjective::isNotable ( )

Implements ILIAS\Setup\Objective.

Definition at line 64 of file class.ilStyleReplaceResponsiveLogoObjective.php.

                                 : bool
     {
         return true;
     }

◆ maybeReplaceResponsiveIcon()

ilStyleReplaceResponsiveLogoObjective::maybeReplaceResponsiveIcon ( string $skin_path )

protected

Replaces the responsive header-icon with the common header-icon, if the common icon is different from the ilias icon but the responsive icon is not.

Definition at line 109 of file class.ilStyleReplaceResponsiveLogoObjective.php.

References getFileHash().

Referenced by achieve().

                                                                      : void
     {
         $responsive_logo = $skin_path . self::RESPONSIVE_LOGO_PATH;
         $common_logo = $skin_path . self::COMMON_LOGO_PATH;
 
         if ($this->getFileHash($common_logo) !== $this->delos_common_logo_hash &&
             $this->getFileHash($responsive_logo) === $this->delos_responsive_logo_hash
         ) {
             copy($common_logo, $responsive_logo);
         }
     }