ILIAS\StaticURL\Builder\StandardURIBuilder Class Reference

Inheritance diagram for ILIAS\StaticURL\Builder\StandardURIBuilder:

Collaboration diagram for ILIAS\StaticURL\Builder\StandardURIBuilder:

Public Member Functions
	__construct (private Configuration $config,)
	buildLegacy (?int $a_ref_id, string $a_type='', array $a_params=[], string $append="")
	build (string $namespace, ?ReferenceId $reference_id=null, array $additional_parameters=[])
	buildTarget (string $namespace, ?ReferenceId $reference_id=null, array $additional_parameters=[])
	getBaseURI ()
	build (string $namespace, ?ReferenceId $reference_id=null, array $additional_parameters=[])
	buildLegacy (?int $a_ref_id, string $a_type='', array $a_params=[], string $append="")
	getBaseURI ()

Data Fields
const string	SHORT = '/go/'
const string	LONG = '/goto.php/'

Private Attributes
URI	$cache = null

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 31 of file StandardURIBuilder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\StaticURL\Builder\StandardURIBuilder::__construct

(

private Configuration

$config

)

Definition at line 35 of file StandardURIBuilder.php.

      {
    }

Member Function Documentation

build()

ILIAS\StaticURL\Builder\StandardURIBuilder::build	(	string	$namespace,
		?ReferenceId	$reference_id = null,
		array	$additional_parameters = []
	)

Implements ILIAS\StaticURL\Builder\URIBuilder.

Definition at line 71 of file StandardURIBuilder.php.

     : URI {
        $uri = $this->getBaseURI()
            . $this->config->get(Config::STATIC_LINK_ENDPOINT)
            . $this->buildTarget($namespace, $reference_id, $additional_parameters);
 
        return new URI($uri);
    }

buildLegacy()

ILIAS\StaticURL\Builder\StandardURIBuilder::buildLegacy	(	?int	$a_ref_id,
		string	$a_type = '',
		array	$a_params = [],
		string	$append = ""
	)

Deprecated:

This only replaces the code from ilLink, use @build() instead.

Implements ILIAS\StaticURL\Builder\URIBuilder.

Definition at line 43 of file StandardURIBuilder.php.

     : string {
        global $DIC; // we do not inject this since it's e depreacted method
 
        $ilObjDataCache = $DIC["ilObjDataCache"];
 
        if ($a_type === '' && $a_ref_id) {
            $a_type = $ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($a_ref_id));
        }
 
        $a_params = array_merge($a_params, [$append]);
        $a_params = array_filter($a_params, static fn($value): bool => $value !== "");
 
        if (!empty($a_type)) {
            return (string) $this->build(
                $a_type,
                $a_ref_id !== null ? new ReferenceId($a_ref_id) : null,
                $a_params
            );
        }
 
        return '';
    }

buildTarget()

ILIAS\StaticURL\Builder\StandardURIBuilder::buildTarget	(	string	$namespace,
		?ReferenceId	$reference_id = null,
		array	$additional_parameters = []
	)

Definition at line 83 of file StandardURIBuilder.php.

     : string {
        return $namespace
            . ($reference_id !== null ? '/' . $reference_id->toInt() : '')
            . '/'
            . implode('/', $additional_parameters);
    }

getBaseURI()

ILIAS\StaticURL\Builder\StandardURIBuilder::getBaseURI

(

)

Implements ILIAS\StaticURL\Builder\URIBuilder.

Definition at line 94 of file StandardURIBuilder.php.

                                : URI
    {
        if ($this->cache !== null) {
            return $this->cache;
        }
 
        $base_path = $this->config->get(Config::BASE_URL);
 
        $offset = match (true) {
            str_contains((string) $base_path, self::SHORT) => strpos((string) $base_path, self::SHORT),
            str_contains((string) $base_path, self::LONG) => strpos((string) $base_path, rtrim(self::LONG, '/')),
            str_contains((string) $base_path, rtrim(self::LONG, '/')) => strpos((string) $base_path, rtrim(self::LONG, '/')),
            str_contains((string) $base_path, 'Customizing') => strpos((string) $base_path, 'Customizing'),
            str_contains((string) $base_path, 'src') => strpos((string) $base_path, 'src'),
            str_contains((string) $base_path, 'webservices') => strpos((string) $base_path, 'webservices'),
            default => false,
        };
 
        if ($offset === false) {
            return $this->cache = new URI(trim((string) $base_path, '/'));
        }
 
        $uri_string = substr(
            (string) $base_path,
            0,
            $offset
        );
        return $this->cache = new URI(
            trim($uri_string, '/')
        );
    }

Field Documentation

$cache

URI ILIAS\StaticURL\Builder\StandardURIBuilder::$cache = null

private

Definition at line 33 of file StandardURIBuilder.php.

LONG

const string ILIAS\StaticURL\Builder\StandardURIBuilder::LONG = '/goto.php/'

Definition at line 41 of file StandardURIBuilder.php.

Referenced by ILIAS\StaticURL\Request\LegacyRequestBuilder\buildRequest(), ILIAS\StaticURL\Request\ShortlinkRequestBuilder\buildRequest(), ILIAS\StaticURL\StaticURLConfig\get(), and ILIAS\StaticURL\Shortlinks\Handler\mustShift().

SHORT

const string ILIAS\StaticURL\Builder\StandardURIBuilder::SHORT = '/go/'

Definition at line 40 of file StandardURIBuilder.php.

Referenced by ILIAS\StaticURL\Request\LegacyRequestBuilder\buildRequest(), ILIAS\StaticURL\Request\ShortlinkRequestBuilder\buildRequest(), ILIAS\StaticURL\StaticURLConfig\get(), ILIAS\StaticURL\Shortlinks\Handler\mustShift(), and ILIAS\Init\StartupSequence\StartUpSequenceDispatcher\storeRequest().

---

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

• components/ILIAS/StaticURL/src/Builder/StandardURIBuilder.php