PHP Class Neos\Neos\Domain\Model\Domain

It is used to connect a site root node to a specific hostname.
Inheritance: implements Neos\Cache\CacheAwareInterface
Show file Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property Type Description
$active boolean If domain is active
$hostname string
$port integer
$scheme string
$site Site

Public Methods

Method Description
__toString ( ) : string Returns a URI string representation of this domain
getActive ( ) : boolean Returns if the domain is active
getCacheEntryIdentifier ( )
getHostPattern ( ) : string Returns the hostname
getHostname ( ) : string Returns the hostname
getPort ( ) : integer Returns the port for this domain
getScheme ( ) : string Returns the scheme for this domain
getSite ( ) : Site Returns the site this domain is pointing to
onPostFlush ( ) : void Internal event handler to forward domain changes to the "siteChanged" signal
setActive ( boolean $active ) : void Sets if the domain is active
setHostPattern ( string $hostPattern ) : void Sets the hostname
setHostname ( string $hostname ) : void Sets the hostname
setPort ( integer $port = null ) : void Sets the port for the domain
setScheme ( string $scheme = null ) : void Sets the scheme for the domain
setSite ( Site $site ) : void Sets the site this domain is pointing to

Method Details

__toString() public method

Returns a URI string representation of this domain
public __toString ( ) : string
return string This domain as a URI string

getActive() public method

Returns if the domain is active
public getActive ( ) : boolean
return boolean If active or not

getCacheEntryIdentifier() public method

public getCacheEntryIdentifier ( )

getHostPattern() public method

Returns the hostname
Deprecation: after 3.0, use getHostname() instead
public getHostPattern ( ) : string
return string The name

getHostname() public method

Returns the hostname
public getHostname ( ) : string
return string

getPort() public method

Returns the port for this domain
public getPort ( ) : integer
return integer The port

getScheme() public method

Returns the scheme for this domain
public getScheme ( ) : string
return string The scheme

getSite() public method

Returns the site this domain is pointing to
public getSite ( ) : Site
return Site

onPostFlush() public method

Internal event handler to forward domain changes to the "siteChanged" signal
public onPostFlush ( ) : void
return void

setActive() public method

Sets if the domain is active
public setActive ( boolean $active ) : void
$active boolean If the domain is active
return void

setHostPattern() public method

Sets the hostname
Deprecation: after 3.0, use setHostname() instead
public setHostPattern ( string $hostPattern ) : void
$hostPattern string
return void

setHostname() public method

Sets the hostname
public setHostname ( string $hostname ) : void
$hostname string
return void

setPort() public method

Sets the port for the domain
public setPort ( integer $port = null ) : void
$port integer Port for the domain
return void

setScheme() public method

Sets the scheme for the domain
public setScheme ( string $scheme = null ) : void
$scheme string Scheme for the domain
return void

setSite() public method

Sets the site this domain is pointing to
public setSite ( Site $site ) : void
$site Site The site
return void

Property Details

$active protected property

If domain is active
protected bool $active
return boolean

$hostname protected property

protected string $hostname
return string

$port protected property

protected int $port
return integer

$scheme protected property

protected string $scheme
return string

$site protected property

protected Site,Neos\Neos\Domain\Model $site
return Site