API Documentation for: 1.1.1
Show:

DeploymentStatus Class

Namespace: Canteen\Server

Does a check on the server host to see what server settings we should be using. Located in the namespace Canteen\Server.

Constructor

DeploymentStatus

(
  • settingsPath
  • [domain=null]
)

Parameters:

  • settingsPath String | Array

    The path to the settings PHP file or an Array

  • [domain=null] String optional

    The domain to specific where we're coming from (optional) checks the server constants if domain is not supplied

Methods

isAssoc

(
  • arr
)
Boolean private

Check to see if an array is associative

Parameters:

  • arr Array

    The array to check

Returns:

Boolean:

if the array is associative

processURI

(
  • basePath
)
private

Process the site URI

Parameters:

  • basePath String

    The base path of the site, if any

Properties

defaultSettings

Dictionary private

The default settings

defaultSettings.cacheDirectory

String private

The location of the write-able cache directory if using cache and memcache isn't enabled.

Default: null

defaultSettings.cacheEnabled

Boolean private

The default deployment setting if cache is enabled

Default: false

defaultSettings.compress

Boolean private

The default deployment setting if gzip compression is on

Default: false

defaultSettings.dbHost

Boolean private

The default deployment database host name

Default: 'localhost'

defaultSettings.debug

Boolean private

The default deployment setting if debug mode is enabled

Default: false

defaultSettings.domain

Boolean private

The default deployment level

Default: '*'

defaultSettings.level

Int private

The default deployment leve

Default: DeployementStatus::LIVE

defaultSettings.minify

String private

The default deployment setting if cache is enabled

Default: false

DEVELOPMENT

Int final static

The deployment level for a development site, typically development sites change nightly or very frequently.

LIVE

Int final static

The deployment level for a live site.

LOCAL

Int final static

The deployment level for a local site which us usually only for local development and is not typically viewable anyone but the developer.

properties

Dictionary public

Save the collection of deployable configuration variables

STAGING

Int final static

The deployment level for a staging site, typically a place where a site lives before it's ready to go live. Changes infrequently.