ilLTIConsumeProviderIcon Class Reference

Collaboration diagram for ilLTIConsumeProviderIcon:

Public Member Functions
	__construct (int $providerId, string $filename='')
	ilLTIConsumeProviderIcon constructor. More...
	buildFilename ($fileExtension)
	getFilename ()
	setFilename (string $filename)
	getRelativeDirectory ()
	getRelativeFilePath ()
	getAbsoluteFilePath ()
	exists ()
	handleUploadInputSubission (ilImageFileInputGUI $fileInput)

Static Public Member Functions
static	getSupportedFileExtensions ()

Data Fields
const	MAX_ICON_SIZE = 32

Protected Member Functions
	ensureExistingRelativeDirectory ()
	delete ()
	convert ()
	save (string $uploadFile)

Protected Attributes
	$providerId
	$filename

Static Protected Attributes
static	$RELATIVE_DIRECTORY_PATH
static	$SUPPORTED_FILE_EXTENSIONS

Detailed Description

Definition at line 14 of file class.ilLTIConsumeProviderIcon.php.

Constructor & Destructor Documentation

__construct()

ilLTIConsumeProviderIcon::__construct	(	int	$providerId,
		string	$filename = ''
	)

ilLTIConsumeProviderIcon constructor.

Parameters

int	$providerId
string	$filename

Exceptions

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

References $DIC, $filename, $providerId, and ensureExistingRelativeDirectory().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $this->providerId = $providerId;
        $this->filename = $filename;
        
        $this->ensureExistingRelativeDirectory();
    }

Here is the call graph for this function:

Member Function Documentation

buildFilename()

ilLTIConsumeProviderIcon::buildFilename

(

$fileExtension

)

Definition at line 52 of file class.ilLTIConsumeProviderIcon.php.

Referenced by save().

    {
        return "{$this->providerId}.{$fileExtension}";
    }

Here is the caller graph for this function:

convert()

ilLTIConsumeProviderIcon::convert ( )

protected

Definition at line 142 of file class.ilLTIConsumeProviderIcon.php.

References $type, ilUtil\execConvert(), and getAbsoluteFilePath().

Referenced by save().

    {
        // convert to square with same side length (optimal for tile view)
        
        list($width, $height, $type, $attr) = getimagesize($this->getAbsoluteFilePath());
        $minSize = min($width, $height);
        
        if (self::MAX_ICON_SIZE) {
            $minSize = min($minSize, self::MAX_ICON_SIZE);
        }
        
        $convertCmd = "{$this->getAbsoluteFilePath()}[0]";
        $convertCmd .= " -geometry {$minSize}x{$minSize}^ -gravity center";
        $convertCmd .= " -extent {$minSize}x{$minSize}";
        $convertCmd .= " {$this->getAbsoluteFilePath()}";
        
        ilUtil::execConvert($convertCmd);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilLTIConsumeProviderIcon::delete ( )

protected

Exceptions

Definition at line 131 of file class.ilLTIConsumeProviderIcon.php.

References $DIC, getRelativeFilePath(), and setFilename().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        if ($DIC->filesystem()->web()->has($this->getRelativeFilePath())) {
            $DIC->filesystem()->web()->delete($this->getRelativeFilePath());
        }
        
        $this->setFilename('');
    }

Here is the call graph for this function:

ensureExistingRelativeDirectory()

ilLTIConsumeProviderIcon::ensureExistingRelativeDirectory ( )

protected

Exceptions

Definition at line 104 of file class.ilLTIConsumeProviderIcon.php.

References $DIC, and getRelativeDirectory().

Referenced by __construct().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        if (!$DIC->filesystem()->web()->has($this->getRelativeDirectory())) {
            $DIC->filesystem()->web()->createDir($this->getRelativeDirectory());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exists()

ilLTIConsumeProviderIcon::exists

(

)

Returns

bool

Definition at line 116 of file class.ilLTIConsumeProviderIcon.php.

References $DIC, getFilename(), and getRelativeFilePath().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        if (!strlen($this->getFilename())) {
            return false;
        }
        
        return $DIC->filesystem()->web()->has($this->getRelativeFilePath());
    }

Here is the call graph for this function:

getAbsoluteFilePath()

ilLTIConsumeProviderIcon::getAbsoluteFilePath

(

)

Returns

string

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

References getRelativeFilePath(), and ilUtil\getWebspaceDir().

Referenced by convert().

    {
        return implode(DIRECTORY_SEPARATOR, [
            \ilUtil::getWebspaceDir(), $this->getRelativeFilePath()
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFilename()

ilLTIConsumeProviderIcon::getFilename

(

)

Returns

string

Definition at line 60 of file class.ilLTIConsumeProviderIcon.php.

References $filename.

Referenced by exists(), and getRelativeFilePath().

                                  : string
    {
        return $this->filename;
    }

Here is the caller graph for this function:

getRelativeDirectory()

ilLTIConsumeProviderIcon::getRelativeDirectory

(

)

Returns

string

Definition at line 76 of file class.ilLTIConsumeProviderIcon.php.

Referenced by ensureExistingRelativeDirectory(), getRelativeFilePath(), and save().

    {
        return implode(DIRECTORY_SEPARATOR, self::$RELATIVE_DIRECTORY_PATH);
    }

Here is the caller graph for this function:

getRelativeFilePath()

ilLTIConsumeProviderIcon::getRelativeFilePath

(

)

Returns

string

Definition at line 84 of file class.ilLTIConsumeProviderIcon.php.

References getFilename(), and getRelativeDirectory().

Referenced by delete(), exists(), and getAbsoluteFilePath().

    {
        return implode(DIRECTORY_SEPARATOR, [
            $this->getRelativeDirectory(), $this->getFilename()
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSupportedFileExtensions()

static ilLTIConsumeProviderIcon::getSupportedFileExtensions ( )

static

Returns

array

Definition at line 225 of file class.ilLTIConsumeProviderIcon.php.

Referenced by ilLTIConsumeProviderFormGUI\initForm().

    {
        return self::$SUPPORTED_FILE_EXTENSIONS;
    }

Here is the caller graph for this function:

handleUploadInputSubission()

ilLTIConsumeProviderIcon::handleUploadInputSubission

(

ilImageFileInputGUI

$fileInput

)

Parameters

ilImageFileInputGUI

$fileInput

Exceptions

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

References $_POST, ilImageFileInputGUI\getDeletionFlag(), ilFormPropertyGUI\getPostVar(), and save().

    {
        if ($fileInput->getDeletionFlag()) {
            $this->delete();
        }
        
        // ilImageFileInputGUI does NOT come with a set value that could be fetched with
        // $fileInput->getValue(). Instead ilImageFileInputGUI provides upload info in $_POST.
        $fileData = $_POST[$fileInput->getPostVar()];
        
        if ($fileData['tmp_name']) {
            $this->save($fileData['tmp_name']);
        }
    }

Here is the call graph for this function:

save()

ilLTIConsumeProviderIcon::save ( string  $uploadFile )

protected

Parameters

string

$uploadFile

Exceptions

Definition at line 167 of file class.ilLTIConsumeProviderIcon.php.

References $DIC, $result, $results, buildFilename(), convert(), getRelativeDirectory(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, and setFilename().

Referenced by handleUploadInputSubission().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        if ($DIC->upload()->hasUploads()) {
            if (!$DIC->upload()->hasBeenProcessed()) {
                $DIC->upload()->process();
            }
            
            /* @var \ILIAS\FileUpload\DTO\UploadResult $result */
            
            $results = $DIC->upload()->getResults();
            
            if (isset($results[$uploadFile])) {
                $result = $results[$uploadFile];
                
                if ($result->getStatus() == \ILIAS\FileUpload\DTO\ProcessingStatus::OK) {
                    $fileExtentsion = pathinfo($result->getName(), PATHINFO_EXTENSION);
                    $this->setFilename($this->buildFilename($fileExtentsion));
                    
                    $DIC->upload()->moveOneFileTo(
                        $result,
                        $this->getRelativeDirectory(),
                        \ILIAS\FileUpload\Location::WEB,
                        $this->getFileName(),
                        true
                    );
                    
                    $this->convert();
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFilename()

ilLTIConsumeProviderIcon::setFilename

(

string

$filename

)

Parameters

string

$filename

Definition at line 68 of file class.ilLTIConsumeProviderIcon.php.

References $filename.

Referenced by delete(), and save().

    {
        $this->filename = $filename;
    }

Here is the caller graph for this function:

Field Documentation

$filename

ilLTIConsumeProviderIcon::$filename

protected

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

Referenced by __construct(), getFilename(), and setFilename().

$providerId

ilLTIConsumeProviderIcon::$providerId

protected

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

Referenced by __construct().

$RELATIVE_DIRECTORY_PATH

ilLTIConsumeProviderIcon::$RELATIVE_DIRECTORY_PATH

staticprotected

Initial value:

= [
        'lti_data', 'provider_icon'
    ]

Definition at line 18 of file class.ilLTIConsumeProviderIcon.php.

$SUPPORTED_FILE_EXTENSIONS

ilLTIConsumeProviderIcon::$SUPPORTED_FILE_EXTENSIONS

staticprotected

Initial value:

= [
        'png', 'jpg', 'jpeg'
    ]

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

MAX_ICON_SIZE

const ilLTIConsumeProviderIcon::MAX_ICON_SIZE = 32

Definition at line 16 of file class.ilLTIConsumeProviderIcon.php.

---

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

• Modules/LTIConsumer/classes/class.ilLTIConsumeProviderIcon.php