Oihana PHP

documentUrl.php

Table of Contents

Functions

documentUrl()  : string
Generates a full document URL based on the project's base URL.

Functions

documentUrl()

Generates a full document URL based on the project's base URL.

documentUrl([string $path = Char::EMPTY ][, ContainerInterface|null $container = null ][, string|null $definition = 'baseUrl' ][, bool $trailingSlash = false ]) : string

This helper function is commonly used in IoC container definitions of models to generate the accessible URL of a document or resource.

The function:

  1. Retrieves the base URL from the DI container using the provided definition key (default 'baseUrl').
  2. Joins the base URL with the provided relative path.
  3. Optionally appends a trailing slash.

When no container is given, or when the base URL definition is absent, the base URL falls back to an empty string and only the relative path is returned.

Parameters
$path : string = Char::EMPTY

Relative path of the document (default: empty string).

$container : ContainerInterface|null = null

Optional DI container to fetch the base URL from.

$definition : string|null = 'baseUrl'

Key used to fetch the base URL from the container (default: 'baseUrl').

$trailingSlash : bool = false

Whether to append a trailing slash to the resulting URL (default: false).

Tags
throws
ContainerExceptionInterface

If an error occurs while retrieving an entry from the dependency-injection container.

NotFoundExceptionInterface

If no entry is found for the requested identifier in the container.

example 
use Psr\Container\ContainerInterface;

use function oihana\models\helpers\documentUrl;

// Assuming the container resolves 'baseUrl' to 'https://example.com'
$url = documentUrl( 'uploads/image.png', $container ) ;
// 'https://example.com/uploads/image.png'

$urlWithSlash = documentUrl( 'uploads', $container, 'baseUrl', true ) ;
// 'https://example.com/uploads/'

// Without a container, only the relative path is returned.
$relative = documentUrl( 'uploads/image.png' ) ;
// 'uploads/image.png'
author

Marc Alcaraz (ekameleon)

since
1.0.0
Return values
string —

The fully resolved document URL.

On this page

Search results