ilExportMetadataGatheredObjective Class Reference

Inheritance diagram for ilExportMetadataGatheredObjective:

Collaboration diagram for ilExportMetadataGatheredObjective:

Public Member Functions
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Data Fields
const	EXPORT_META = "export_meta"

Protected Member Functions
	getCurrentGitCommitHash ()

Detailed Description

Definition at line 23 of file class.ilExportMetadataGatheredObjective.php.

Member Function Documentation

achieve()

ilExportMetadataGatheredObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 63 of file class.ilExportMetadataGatheredObjective.php.

                                                           : Setup\Environment
    {
        $meta = [
          "user_name=" . posix_getpwuid(posix_geteuid())['name'],
          "created=" . date('Y-m-d H:i:s'),
          "commit=" . $this->getCurrentGitCommitHash(),
          "host=" . gethostname()
        ];
 
        return $environment->withConfigFor(self::EXPORT_META, $meta);
    }

References getCurrentGitCommitHash(), and ILIAS\Setup\Environment\withConfigFor().

Here is the call graph for this function:

getCurrentGitCommitHash()

ilExportMetadataGatheredObjective::getCurrentGitCommitHash ( )

protected

Definition at line 83 of file class.ilExportMetadataGatheredObjective.php.

                                                : string
    {
        $path = realpath('.git') . DIRECTORY_SEPARATOR;
 
        if (!$path) {
            return "";
        }
 
        $head = trim(substr(file_get_contents($path . 'HEAD'), 4));
        $hash = trim(file_get_contents($path . $head));
 
        return $hash;
    }

References $path.

Referenced by achieve().

Here is the caller graph for this function:

getHash()

ilExportMetadataGatheredObjective::getHash

(

)

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

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

getLabel()

ilExportMetadataGatheredObjective::getLabel

(

)

Definition at line 38 of file class.ilExportMetadataGatheredObjective.php.

                              : string
    {
        return "Gathering export metadata";
    }

getPreconditions()

ilExportMetadataGatheredObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 54 of file class.ilExportMetadataGatheredObjective.php.

                                                                    : array
    {
        return [
        ];
    }

isApplicable()

ilExportMetadataGatheredObjective::isApplicable

(

Setup\Environment

$environment

)

@inheritDoc

Definition at line 78 of file class.ilExportMetadataGatheredObjective.php.

                                                                : bool
    {
        return true;
    }

isNotable()

ilExportMetadataGatheredObjective::isNotable

(

)

Definition at line 46 of file class.ilExportMetadataGatheredObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

EXPORT_META

const ilExportMetadataGatheredObjective::EXPORT_META = "export_meta"

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

Referenced by ilExportZipBuiltObjective\achieve().

---

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

• components/ILIAS/setup_/classes/class.ilExportMetadataGatheredObjective.php