ilCertificateUtilHelper Class Reference

Just a wrapper class to create Unit Test for other classes. More...

Collaboration diagram for ilCertificateUtilHelper:

Public Member Functions
	__construct ()
	deliverData (string $data, string $fileName, string $mimeType)
	prepareFormOutput (string $string)
	convertImage (string $from, string $to, string $geometry='')
	stripSlashes (string $string)
	zipAndDeliver (array $streams, string $download_filename)
	getDir (string $copyDirectory)
	unzip (string $file, string $zip_output_path, bool $overwrite)
	delDir (string $path)
	moveUploadedFile (string $file, string $name, string $target, bool $raise_errors=true, string $mode='move_uploaded')
	getImagePath (string $img, string $module_path="", string $mode="output", bool $offline=false)

Private Attributes
ILIAS Filesystem Util Convert Images	$image_converter
ILIAS Filesystem Util Archive Archives	$archives
ILIAS FileDelivery Services	$delivery

Detailed Description

Just a wrapper class to create Unit Test for other classes.

Can be remove when the static method calls have been removed

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 31 of file ilCertificateUtilHelper.php.

Constructor & Destructor Documentation

__construct()

ilCertificateUtilHelper::__construct

(

)

Definition at line 37 of file ilCertificateUtilHelper.php.

References $DIC.

    {
        global $DIC;
        $this->image_converter = $DIC->fileConverters()->images();
        $this->archives = $DIC->archives();
        $this->delivery = $DIC->fileDelivery();
    }

Member Function Documentation

convertImage()

ilCertificateUtilHelper::convertImage	(	string	$from,
		string	$to,
		string	$geometry = ''
	)

Definition at line 59 of file ilCertificateUtilHelper.php.

     : void {
        $converter = $this->image_converter->convertToFormat(
            Streams::ofResource(fopen($from, 'rb')),
            ImageOutputOptions::FORMAT_JPG,
            $geometry === '' ? null : (int) $geometry,
            $geometry === '' ? null : (int) $geometry,
            (new ImageOutputOptions())->withQuality(100)
        );

        if (!$converter->isOK()) {
            throw new ilException(
                sprintf(
                    'Could not convert image %s to %s',
                    $from,
                    $to
                ),
                0,
                $converter->getThrowableIfAny()
            );
        }

        $stream = $converter->getStream();

        try {
            $stream->rewind();
            if (file_put_contents($to, $stream->getContents()) === false) {
                throw new ilException(
                    sprintf(
                        'Could not store converted image %s to %s',
                        $from,
                        $to
                    )
                );
            }
        } finally {
            $stream->close();
        }
    }

delDir()

ilCertificateUtilHelper::delDir

(

string

$path

)

Definition at line 134 of file ilCertificateUtilHelper.php.

References ilFileUtils\delDir().

                                        : void
    {
        ilFileUtils::delDir($path);
    }

Here is the call graph for this function:

deliverData()

ilCertificateUtilHelper::deliverData	(	string	$data,
		string	$fileName,
		string	$mimeType
	)

Definition at line 45 of file ilCertificateUtilHelper.php.

References ilUtil\deliverData().

                                                                                 : void
    {
        ilUtil::deliverData(
            $data,
            $fileName,
            $mimeType
        );
    }

Here is the call graph for this function:

getDir()

ilCertificateUtilHelper::getDir

(

string

$copyDirectory

)

Definition at line 118 of file ilCertificateUtilHelper.php.

References ilFileUtils\getDir().

                                                 : array
    {
        return ilFileUtils::getDir($copyDirectory);
    }

Here is the call graph for this function:

getImagePath()

ilCertificateUtilHelper::getImagePath	(	string	$img,
		string	$module_path = "",
		string	$mode = "output",
		bool	$offline = false
	)

Definition at line 158 of file ilCertificateUtilHelper.php.

References ilUtil\getImagePath().

     : string {
        return ilUtil::getImagePath(
            $img,
            $module_path,
            $mode,
            $offline
        );
    }

Here is the call graph for this function:

moveUploadedFile()

ilCertificateUtilHelper::moveUploadedFile	(	string	$file,
		string	$name,
		string	$target,
		bool	$raise_errors = true,
		string	$mode = 'move_uploaded'
	)

Exceptions

ilException

Definition at line 142 of file ilCertificateUtilHelper.php.

References ilFileUtils\moveUploadedFile().

     : bool {
        return ilFileUtils::moveUploadedFile(
            $file,
            $name,
            $target,
            $raise_errors,
            $mode
        );
    }

Here is the call graph for this function:

prepareFormOutput()

ilCertificateUtilHelper::prepareFormOutput

(

string

$string

)

Definition at line 54 of file ilCertificateUtilHelper.php.

References ilLegacyFormElementsUtil\prepareFormOutput().

                                                     : string
    {
        return ilLegacyFormElementsUtil::prepareFormOutput($string);
    }

Here is the call graph for this function:

stripSlashes()

ilCertificateUtilHelper::stripSlashes

(

string

$string

)

Definition at line 102 of file ilCertificateUtilHelper.php.

References ilUtil\stripSlashes().

                                                : string
    {
        return ilUtil::stripSlashes($string);
    }

Here is the call graph for this function:

unzip()

ilCertificateUtilHelper::unzip	(	string	$file,
		string	$zip_output_path,
		bool	$overwrite
	)

Definition at line 123 of file ilCertificateUtilHelper.php.

                                                                                 : Unzip
    {
        return $this->archives->unzip(
            Streams::ofResource(fopen($file, 'rb')),
            $this->archives->unzipOptions()
                           ->withOverwrite($overwrite)
                           ->withZipOutputPath($zip_output_path)
                           ->withDirectoryHandling(ZipDirectoryHandling::KEEP_STRUCTURE)
        );
    }

zipAndDeliver()

ilCertificateUtilHelper::zipAndDeliver	(	array	$streams,
		string	$download_filename
	)

Parameters

list<Streams>

$streams

Definition at line 110 of file ilCertificateUtilHelper.php.

                                                                            : void
    {
        $this->delivery->delivery()->attached(
            $this->archives->zip($streams)->get(),
            $download_filename
        );
    }

Field Documentation

$archives

ILIAS Filesystem Util Archive Archives ilCertificateUtilHelper::$archives

private

Definition at line 34 of file ilCertificateUtilHelper.php.

$delivery

ILIAS FileDelivery Services ilCertificateUtilHelper::$delivery

private

Definition at line 35 of file ilCertificateUtilHelper.php.

$image_converter

ILIAS Filesystem Util Convert Images ilCertificateUtilHelper::$image_converter

private

Definition at line 33 of file ilCertificateUtilHelper.php.

---

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

• Services/Certificate/classes/Helper/ilCertificateUtilHelper.php