Subsites class - Documentation for SproutCMS

Info Page:

Page options:

class Subsites

Provides functions for getting information about subsites

File: /sprout/Helpers/Subsites.php
Namespace: Sprout\Helpers

Variables

Name	Visibility	Description
`$configs`	(static)
`$subsites`	(static)

Functions

Name	Visibility	Description
determineBestDomain	private (static)	For a given list of domains, determine the best match based on the current HTTP_HOST
getAbsRoot	public (static)	Returns the abs root (including protocol and server name) of the specified subsite
getAbsRootAdmin	public (static)	Returns the abs root (including protocol and server name) of the current admin subsite
getCode	public (static)	Returns the name of the specified subsite
getCodes	public (static)	Gets the list of subsite codes which are available, by reading the appropriate directory
getConfig	public (static)	Get a config value for a given subsite
getConfigAdmin	public (static)	Admin version of the getConfig function, uses the currently active subsite
getFirstAccessable	public (static)	Returns the id of the first subsite in the list (alphabetical) that the user is able to access.
getName	public (static)	Returns the name of the specified subsite
hasMultiple	public (static)	Determines if multiple subsites can be accessed by the currently logged in administrator
listSelector	public (static)	Outputs a select UL for choosing a subsite from within the admin area
loadConfig	public (static)	Load the configuration for a subsite code.
loadSubsites	private (static)	Loads all the subsites into memory, ready for further processing

private determineBestDomain

unknown Subsites::determineBestDomain ( mixed $domains );

For a given list of domains, determine the best match based on the current HTTP_HOST

If there is an exact match, it is used
If there is an ends-with match, it is used
Failing all that, the first domain in the list is used

public getAbsRoot

string Subsites::getAbsRoot ( int $id [, string $protocol ] );

Returns the abs root (including protocol and server name) of the specified subsite
Falls back to the current root if no abs root can be found in the database

public getAbsRootAdmin

unknown Subsites::getAbsRootAdmin ( );

Returns the abs root (including protocol and server name) of the current admin subsite

public getCode

unknown Subsites::getCode ( mixed $id );

Returns the name of the specified subsite

public getCodes

array Subsites::getCodes ( );

Gets the list of subsite codes which are available, by reading the appropriate directory

public getConfig

mixed Subsites::getConfig ( string $key , int $subsite_id );

Get a config value for a given subsite

Use this instead of Kohana::config, if you need to target a specific subsite.
It always looks in the "sprout" config file, doesn't support other files.

public getConfigAdmin

unknown Subsites::getConfigAdmin ( mixed $key );

Admin version of the getConfig function, uses the currently active subsite

public getFirstAccessable

unknown Subsites::getFirstAccessable ( );

Returns the id of the first subsite in the list (alphabetical) that the user is able to access.
Returns null if there are no subsites the user can access.

public getName

unknown Subsites::getName ( mixed $id );

Returns the name of the specified subsite

public hasMultiple

bool Subsites::hasMultiple ( );

Determines if multiple subsites can be accessed by the currently logged in administrator

public listSelector

void Subsites::listSelector ( [ int $selected_id ] );

Outputs a select UL for choosing a subsite from within the admin area

public loadConfig

unknown Subsites::loadConfig ( string $subsite_code );

Load the configuration for a subsite code.
It will only be loaded once per request - it gets cached in a static var

private loadSubsites

void Subsites::loadSubsites ( );

Loads all the subsites into memory, ready for further processing

SproutCMS

Search documentation