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 string $ILIAS_HTTP_PATH, private bool $short_url_possible=false)
	build (string $namespace, ?ReferenceId $reference_id=null, array $additional_parameters=[])
	buildTarget (string $namespace, ?ReferenceId $reference_id=null, array $additional_parameters=[])
	getBaseURI ()

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

Detailed Description

Author

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

Definition at line 29 of file StandardURIBuilder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\StaticURL\Builder\StandardURIBuilder::__construct	(	private string	$ILIAS_HTTP_PATH,
		private bool	$short_url_possible = false
	)

Definition at line 31 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 40 of file StandardURIBuilder.php.

References ILIAS\StaticURL\Builder\StandardURIBuilder\buildTarget(), and ILIAS\StaticURL\Builder\StandardURIBuilder\getBaseURI().

Referenced by ILIAS\StaticURL\Tests\URIBuilderTest\testFullBuilder().

     : URI {
        $uri = $this->getBaseURI()
            . ($this->short_url_possible ? self::SHORT : self::LONG)
            . $this->buildTarget($namespace, $reference_id, $additional_parameters);

        return new URI($uri);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildTarget()

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

Definition at line 52 of file StandardURIBuilder.php.

Referenced by ILIAS\StaticURL\Builder\StandardURIBuilder\build().

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

Here is the caller graph for this function:

getBaseURI()

ILIAS\StaticURL\Builder\StandardURIBuilder::getBaseURI

(

)

Implements ILIAS\StaticURL\Builder\URIBuilder.

Definition at line 63 of file StandardURIBuilder.php.

Referenced by ILIAS\StaticURL\Builder\StandardURIBuilder\build(), and ILIAS\StaticURL\Tests\URIBuilderTest\testBaseURI().

                                : URI
    {
        $base_path = $this->ILIAS_HTTP_PATH;

        $offset = match (true) {
            str_contains($base_path, self::SHORT) => strpos($base_path, self::SHORT),
            str_contains($base_path, self::LONG) => strpos($base_path, rtrim(self::LONG, '/')),
            str_contains($base_path, rtrim(self::LONG, '/')) => strpos($base_path, rtrim(self::LONG, '/')),
            str_contains($base_path, 'Customizing') => strpos($base_path, 'Customizing'),
            str_contains($base_path, 'src') => strpos($base_path, 'src'),
            str_contains($base_path, 'webservices') => strpos($base_path, 'webservices'),
            default => false,
        };

        if ($offset === false) {
            return new URI(trim($base_path, '/'));
        }

        $uri_string = substr(
            $base_path,
            0,
            $offset
        );
        return new URI(
            trim($uri_string, '/')
        );
    }

Here is the caller graph for this function:

Field Documentation

LONG

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

Definition at line 38 of file StandardURIBuilder.php.

Referenced by ILIAS\StaticURL\Request\LegacyRequestBuilder\buildRequest().

SHORT

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

Definition at line 37 of file StandardURIBuilder.php.

Referenced by ILIAS\StaticURL\Request\LegacyRequestBuilder\buildRequest().

---

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

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