SiteAliasWithConfig
class SiteAliasWithConfig implements SiteAliasInterface, ConfigRuntimeInterface (View source)
SiteAliasWithConfig delegates to a site alias, and also combines it with two config stores:
- Runtime config (set on commandline): Options that override site alias contents
- Default config (set from config files): Default options
Traits
Common implementation of some SiteAlias methods.
Properties
| protected | $runtimeConfig | ||
| protected | $siteAlias | ||
| protected | $defaultConfig |
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
combine the provided site alias with configuration.
Determine what object to use for the runtime config. If a specific runtime config is given, use that. Otherwise, pull it from the default configuration if available.
No description
No description
No description
No description
No description
No description
No description
No description
Export all configuration as a nested array.
No description
No description
No description
No description
No description
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(SiteAliasInterface $siteAlias, ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig)
No description
static SiteAlias
create(SiteAliasInterface $siteAlias, ConfigInterface $defaultConfig, ConfigInterface|null $runtimeConfig = null)
combine the provided site alias with configuration.
static protected
determineCorrectRuntimeConfig(ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig)
Determine what object to use for the runtime config. If a specific runtime config is given, use that. Otherwise, pull it from the default configuration if available.
runtimeConfig()
No description
string
name()
No description
has($key)
No description
get($key, $defaultFallback = null)
No description
set($key, $value)
No description
import($data)
No description
replace($data)
No description
combine($data)
No description
export()
Export all configuration as a nested array.
hasDefault($key)
No description
getDefault($key, $defaultFallback = null)
No description
setDefault($key, $value)
No description
exportConfig()
No description
protected
changesProhibited()
No description