SiteAlias
class SiteAlias extends Config implements SiteAliasInterface (View source)
An alias record is a configuration record containing well-known items.
Traits
Common implementation of some SiteAlias methods.
Properties
| protected string | $name |
Methods
os returns the OS that this alias record points to. For local alias
records, PHP_OS will be returned. For remote alias records, the
value from the os element will be returned. If there is no os
element, then the default assumption is that the remote system is Linux.
No description
No description
No description
Reconfigure data exported from the form it is expected to be in inside an alias record to the form it is expected to be in when inside a configuration file.
Fetch the parameter-specific options from the 'alias-parameters' section of the alias.
Convert the data in this record to the layout that was used in the legacy code, for backwards compatiblity.
Conversion table from old to new option names. These all implicitly
go in options, although they can come from different locations.
Details
hasRoot()
No description
root()
No description
uri()
No description
setUri($uri)
No description
remoteHostWithUser()
No description
remoteUser()
No description
hasRemoteUser()
No description
remoteHost()
No description
isRemote()
No description
isLocal()
No description
isContainer()
No description
isNone()
No description
localRoot()
No description
string
os()
os returns the OS that this alias record points to. For local alias
records, PHP_OS will be returned. For remote alias records, the
value from the os element will be returned. If there is no os
element, then the default assumption is that the remote system is Linux.
__construct(array|null $data = null, $name = '', $env = '')
No description
string
name()
No description
exportConfig()
No description
protected
remap($data)
Reconfigure data exported from the form it is expected to be in inside an alias record to the form it is expected to be in when inside a configuration file.
protected array
getParameterSpecificOptions($aliasData, string $parameterName)
Fetch the parameter-specific options from the 'alias-parameters' section of the alias.
legacyRecord()
Convert the data in this record to the layout that was used in the legacy code, for backwards compatiblity.
protected
remapOptionTable()
Conversion table from old to new option names. These all implicitly
go in options, although they can come from different locations.