UriFactory
in package
AbstractYes
URI Factory Class
The URI factory can be used to generate URI objects from strings, using a different URI subclass depending on the input URI scheme. New scheme-specific classes can be registered using the registerScheme() method.
Note that this class contains only static methods and should not be instantiated
Table of Contents
Properties
- $schemeClasses : array<string|int, mixed>
- Registered scheme-specific classes
Methods
- factory() : Uri
- Create a URI from a string
- getRegisteredSchemeClass() : string|null
- Get the class name for a registered scheme
- registerScheme() : mixed
- Register a scheme-specific class to be used
- unregisterScheme() : mixed
- Unregister a scheme
Properties
$schemeClasses
Registered scheme-specific classes
protected
static array<string|int, mixed>
$schemeClasses
= ['http' => \Laminas\Uri\Http::class, 'https' => \Laminas\Uri\Http::class, 'mailto' => \Laminas\Uri\Mailto::class, 'file' => \Laminas\Uri\File::class, 'urn' => \Laminas\Uri\Uri::class, 'tag' => \Laminas\Uri\Uri::class]
Methods
factory()
Create a URI from a string
public
static factory(string $uriString[, string $defaultScheme = null ]) : Uri
Parameters
- $uriString : string
- $defaultScheme : string = null
Tags
Return values
UrigetRegisteredSchemeClass()
Get the class name for a registered scheme
public
static getRegisteredSchemeClass(string $scheme) : string|null
If provided scheme is not registered, will return NULL
Parameters
- $scheme : string
Return values
string|nullregisterScheme()
Register a scheme-specific class to be used
public
static registerScheme(string $scheme, string $class) : mixed
Parameters
- $scheme : string
- $class : string
unregisterScheme()
Unregister a scheme
public
static unregisterScheme(string $scheme) : mixed
Parameters
- $scheme : string