ilPDFGenerationRequest Class Reference

Collaboration diagram for ilPDFGenerationRequest:

Public Member Functions
	__construct (\ILIAS\Refinery\Factory $refinery, \ILIAS\HTTP\GlobalHttpState $http)
	securedString (string $parameter, bool $cast_null_to_string=true)
	isNotValidSize (array $sizes)
	isNotValidText (array $texts)
	validatePathOrUrl (array $parameters)
	int (string $parameter, bool $cast_null_to_int=true)
	bool (string $parameter, bool $cast_null_to_false=true)
	float (string $parameter, bool $cast_null_to_zero=true)

Protected Member Functions
	isPathOrUrlValid (string $url)

Private Attributes
ILIAS Refinery Factory	$refinery
ILIAS HTTP GlobalHttpState	$http

Detailed Description

Deprecated:

Definition at line 24 of file class.ilPDFGenerationRequest.php.

Constructor & Destructor Documentation

__construct()

ilPDFGenerationRequest::__construct	(	\ILIAS\Refinery\Factory	$refinery,
		\ILIAS\HTTP\GlobalHttpState	$http
	)

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

    {
        $this->refinery = $refinery;
        $this->http = $http;
    }

References $http, $refinery, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

bool()

ilPDFGenerationRequest::bool	(	string	$parameter,
		bool	$cast_null_to_false = true
	)

Definition at line 184 of file class.ilPDFGenerationRequest.php.

                                                                            : bool
    {
        $null_to_false = $this->refinery->custom()->transformation(static function ($value): bool {
            if ($value === null) {
                return false;
            }
 
            throw new ilException('Expected null in transformation');
        });
 
        $as_bool = $cast_null_to_false ?
            $this->refinery->byTrying([$this->refinery->kindlyTo()->bool(), $null_to_false]) :
            $this->refinery->kindlyTo()->bool();
 
        $bool = false;
        if ($this->http->wrapper()->post()->has($parameter)) {
            $bool = $this->http->wrapper()->post()->retrieve(
                $parameter,
                $as_bool
            );
        } elseif ($this->http->wrapper()->query()->has($parameter)) {
            $bool = $this->http->wrapper()->query()->retrieve(
                $parameter,
                $as_bool
            );
        }
 
        return $bool;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

float()

ilPDFGenerationRequest::float	(	string	$parameter,
		bool	$cast_null_to_zero = true
	)

Definition at line 214 of file class.ilPDFGenerationRequest.php.

                                                                            : float
    {
        $null_to_zero = $this->refinery->custom()->transformation(static function ($value): float {
            if ($value === null) {
                return 0.0;
            }
 
            throw new ilException('Expected null in transformation');
        });
 
        $as_float = $cast_null_to_zero ?
            $this->refinery->byTrying([$this->refinery->kindlyTo()->float(), $null_to_zero]) :
            $this->refinery->kindlyTo()->float();
 
        $float = 0.0;
        if ($this->http->wrapper()->post()->has($parameter)) {
            $float = $this->http->wrapper()->post()->retrieve(
                $parameter,
                $as_float
            );
        } elseif ($this->http->wrapper()->query()->has($parameter)) {
            $float = $this->http->wrapper()->query()->retrieve(
                $parameter,
                $as_float
            );
        }
 
        return $float;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

int()

ilPDFGenerationRequest::int	(	string	$parameter,
		bool	$cast_null_to_int = true
	)

Definition at line 154 of file class.ilPDFGenerationRequest.php.

                                                                         : int
    {
        $null_to_zero = $this->refinery->custom()->transformation(static function ($value): int {
            if ($value === null) {
                return 0;
            }
 
            throw new ilException('Expected null in transformation');
        });
 
        $as_int = $cast_null_to_int ?
            $this->refinery->byTrying([$this->refinery->kindlyTo()->int(), $null_to_zero]) :
            $this->refinery->kindlyTo()->int();
 
        $int = 0;
        if ($this->http->wrapper()->post()->has($parameter)) {
            $int = $this->http->wrapper()->post()->retrieve(
                $parameter,
                $as_int
            );
        } elseif ($this->http->wrapper()->query()->has($parameter)) {
            $int = $this->http->wrapper()->query()->retrieve(
                $parameter,
                $as_int
            );
        }
 
        return $int;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

isNotValidSize()

ilPDFGenerationRequest::isNotValidSize

(

array

$sizes

)

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

                                                : bool
    {
        foreach ($sizes as $size) {
            if (is_int($size)) {
                continue;
            }
            if (!preg_match('/(\d)+?(\W)*(cm|mm)$/', $size)) {
                if ($size !== 0 && $size !== "0" && $size !== null && $size !== "") {
                    return true;
                }
            }
        }
 
        return false;
    }

isNotValidText()

ilPDFGenerationRequest::isNotValidText

(

array

$texts

)

Definition at line 120 of file class.ilPDFGenerationRequest.php.

                                                : bool
    {
        foreach ($texts as $text) {
            if (!preg_match('/[a-zA-Z\d ]+$/', $text)) {
                if ($text !== '' && $text !== null) {
                    return true;
                }
            }
        }
 
        return false;
    }

isPathOrUrlValid()

ilPDFGenerationRequest::isPathOrUrlValid ( string  $url )

protected

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

                                                    : bool
    {
        $is_valid = false;
        $is_url = filter_var($url, FILTER_VALIDATE_URL);
 
        if ($is_url) {
            try {
                $c = new ilCurlConnection($url);
                $c->init();
                $c->setOpt(CURLOPT_CUSTOMREQUEST, 'HEAD');
                $c->setOpt(CURLOPT_SSL_VERIFYPEER, 0);
                $c->setOpt(CURLOPT_SSL_VERIFYHOST, 0);
                $c->setOpt(CURLOPT_RETURNTRANSFER, 1);
                $c->setOpt(CURLOPT_FOLLOWLOCATION, 0);
                $c->setOpt(CURLOPT_MAXREDIRS, 0);
                $c->setOpt(CURLOPT_URL, $url);
                $c->setOpt(CURLOPT_HEADER, true);
                $c->setOpt(CURLOPT_NOBODY, true);
 
                $result = $c->exec();
                $is_valid = $c->getInfo(CURLINFO_HTTP_CODE) === 200;
 
            } catch (ilCurlConnectionException $e) {
                return false;
            }
        } elseif (is_file($url)) {
            $is_valid = true;
        }
 
        return $is_valid;
    }

References $c, Vendor\Package\$e, and $url.

Referenced by validatePathOrUrl().

Here is the caller graph for this function:

securedString()

ilPDFGenerationRequest::securedString	(	string	$parameter,
		bool	$cast_null_to_string = true
	)

Definition at line 35 of file class.ilPDFGenerationRequest.php.

                                                                                      : string
    {
        $as_sanizited_string = $this->refinery->custom()->transformation(static function (string $value): string {
            return ilUtil::stripSlashes($value);
        });
 
        $null_to_empty_string = $this->refinery->custom()->transformation(static function ($value): string {
            if ($value === null) {
                return '';
            }
 
            throw new ilException('Expected null in transformation');
        });
 
        $sanizite_as_string = $this->refinery->in()->series([
            $cast_null_to_string ?
                $this->refinery->byTrying([$this->refinery->kindlyTo()->string(), $null_to_empty_string]) :
                $this->refinery->kindlyTo()->string(),
            $as_sanizited_string
        ]);
 
        $string = '';
        if ($this->http->wrapper()->post()->has($parameter)) {
            $string = $this->http->wrapper()->post()->retrieve(
                $parameter,
                $sanizite_as_string
            );
        } elseif ($this->http->wrapper()->query()->has($parameter)) {
            $string = $this->http->wrapper()->query()->retrieve(
                $parameter,
                $sanizite_as_string
            );
        }
 
        return $string;
    }

References ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Referenced by validatePathOrUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

validatePathOrUrl()

ilPDFGenerationRequest::validatePathOrUrl

(

array

$parameters

)

Parameters

array

$parameters

Returns

bool

Definition at line 137 of file class.ilPDFGenerationRequest.php.

                                                        : bool
    {
        $valid = false;
        foreach ($parameters as $parameter) {
            $value = $this->securedString($parameter);
            if ($value === '') {
                $valid = true;
            } else {
                $valid = $this->isPathOrUrlValid($value);
            }
            if ($valid === false) {
                return false;
            }
        }
        return true;
    }

References $valid, isPathOrUrlValid(), and securedString().

Here is the call graph for this function:

Field Documentation

$http

ILIAS HTTP GlobalHttpState ilPDFGenerationRequest::$http

private

Definition at line 27 of file class.ilPDFGenerationRequest.php.

Referenced by __construct().

$refinery

ILIAS Refinery Factory ilPDFGenerationRequest::$refinery

private

Definition at line 26 of file class.ilPDFGenerationRequest.php.

Referenced by __construct().

---

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

• Services/PDFGeneration/classes/class.ilPDFGenerationRequest.php