Frontend | Backend | Api

AuthSite (Api)

Current site. Can be access with $_currentSite

Property Description Returns
id Returns the ID of the identified site int
environmentId Returns the ID of the identified environment int
clientId Returns the client ID of the identified site int
name Returns the name of current site string
hostname Returns the hostname for the current site as a string string
sitePath Returns the site path for the current site string
primaryEnvironment Checks whether the current environment is the primary environment for the site bool
primaryHostname Checks whether the current hostname is the primary hostname for current environment bool
primary Checks whether the current hostname is the primary hostname for the site. Also checks whether the current environment is the primary environment for the site. bool
primaryHostname Returns the primary hostname of the current environment. Returns null if the site does not have a current environment does not have a primary hostname. string
primaryEnvironmentPrimaryHostname Returns the primary hostname of the primary environment. Returns null if the site does not have a primary environment or hostname. string
environmentName Returns environment name. string
lastVcsHash Returns the last VCS hash for the current environment. Returns the first 7 characters. string
anySiteLastVcsHash Returns the last VCS hash the current environment, or (if this is empty) for any site's environment where the name matches the current environment. Returns the first 7 characters. string
hostnameOfCurrentEnvironment Checks whether the provided hostname is contained in the hostnames of the current environment bool