Domain
in package
Define common Domain object
This class implements a domain object abstraction layer.
Tags
Table of Contents
- $checked_folder : string|null
- The folder object path
- $data : array<string|int, mixed>|null
- The basic data fields
- $pattern : array<string|int, mixed>|null
- The parts of the domain pattern
- __construct() : mixed
- Construct a new instance of the domain object
- Active() : bool
- Is an active domain?
- Aliases() : array<string|int, mixed>|null
- Get set of alias domains
- DefaultLanguage() : string
- The default language
- Folder() : string|null
- Path to folder A relative path to a storage folder
- FolderDepth() : int
- Get depth in manor of folders that are ignore parents
- HasSiteMap() : bool
- Has a sitemap active?
- Id() : string|null
- The domain id A named domain id, can be set in the administration GUI
- IsUnderConstruction() : bool
- Is 503
- Language() : array<string|int, mixed>|null
- Language list
- MasterDomain() : string|null
- The main domain
- Matches() : bool|int
- Test domain against pattern
- MatchesAlias() : bool|int
- Is an matching alias domain
- PreferSecureConnection() : bool
- Use secure connection by default?
- Priority() : int|null
- The sort priority Used in the domain finder to define the order of pattern matches. Lower match before
- _matches() : false|int
- Match helper
Properties
$checked_folder
The folder object path
private
string|null
$checked_folder
= null
$data
The basic data fields
private
array<string|int, mixed>|null
$data
$pattern
The parts of the domain pattern
private
array<string|int, mixed>|null
$pattern
= null
Methods
__construct()
Construct a new instance of the domain object
public
__construct([ $values = null ]) : mixed
Parameters
Return values
mixed —Active()
Is an active domain?
public
Active() : bool
Return values
bool —Aliases()
Get set of alias domains
public
Aliases() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —DefaultLanguage()
The default language
public
DefaultLanguage() : string
The default language for this domain. Fallback to default system language
Return values
string —Folder()
Path to folder A relative path to a storage folder
public
Folder() : string|null
Return values
string|null —The path
FolderDepth()
Get depth in manor of folders that are ignore parents
public
FolderDepth() : int
Return values
int —HasSiteMap()
Has a sitemap active?
public
HasSiteMap() : bool
Return values
bool —Id()
The domain id A named domain id, can be set in the administration GUI
public
Id() : string|null
Return values
string|null —IsUnderConstruction()
Is 503
public
IsUnderConstruction() : bool
Return values
bool —Language()
Language list
public
Language() : array<string|int, mixed>|null
Load the list of active languages for this domain
Return values
array<string|int, mixed>|null —MasterDomain()
The main domain
public
MasterDomain() : string|null
The master domain for this matcher, will be used in canonical tags also
Return values
string|null —Matches()
Test domain against pattern
public
Matches(string|null $dom) : bool|int
Check if the given FQDN string matches against this domain
Parameters
- $dom : string|null
-
The domain to match against
Return values
bool|int —Does match or, does mach in multiple parts, pattern matches may be lower than actual matches
MatchesAlias()
Is an matching alias domain
public
MatchesAlias(string|null $dom) : bool|int
Parameters
- $dom : string|null
Return values
bool|int —PreferSecureConnection()
Use secure connection by default?
public
PreferSecureConnection() : bool
Return values
bool —Priority()
The sort priority Used in the domain finder to define the order of pattern matches. Lower match before
public
Priority() : int|null
Return values
int|null —_matches()
Match helper
private
_matches( $dom, $list) : false|int