Multisites Class Reference

Inheritance diagram for Multisites:

[legend]List of all members.

Public Member Functions
	expunge ($pMultisiteId=NULL)
	expungePreferences ($pMultisiteId=NULL)
	expungeRestrictions ($pMultisiteId, $pContentId=NULL)
	getMultisites ($pMultisiteId=NULL, $pContentId=NULL)
	insertRestriction (&$pParamHash)
	load ()
	Multisites ()
	store (&$pParamHash)
	verify (&$pParamHash)
	verifyRestrictions (&$pParamHash)
Public Attributes
	$mMultisiteId
	$mPrefs

---

Detailed Description

Definition at line 15 of file Multisites.php.

---

Member Function Documentation

Multisites::expunge

(

$

pMultisiteId = NULL

)

remove server from db

Parameters:

$pMultisiteId

is the id of the server we need to delete public

Definition at line 189 of file Multisites.php.

References $query, $ret, expungePreferences(), expungeRestrictions(), FALSE, mDb, and BitBase::verifyId().

Here is the call graph for this function:

Multisites::expungePreferences

(

$

pMultisiteId = NULL

)

remove all preferences associated with a given server

Parameters:

$pMultisiteId

is the id of the server we need to delete private

Definition at line 226 of file Multisites.php.

References $query, $ret, FALSE, mDb, and BitBase::verifyId().

Referenced by expunge(), and store().

Here is the call graph for this function:

Multisites::expungeRestrictions	(	$	pMultisiteId,
		$	pContentId = NULL
	)

remove restrictions by multisite_id from db

Parameters:

$pMultisiteId

public

Definition at line 206 of file Multisites.php.

References $query, $ret, FALSE, mDb, and BitBase::verifyId().

Referenced by expunge().

Here is the call graph for this function:

Multisites::getMultisites	(	$	pMultisiteId = NULL,
		$	pContentId = NULL
	)

Get the list of servers and their preferences

Parameters:

	if	$pMultisiteId is set, it only gets specified server
	if	$pContentId is set, it selects multisites selected for the specfied content

Definition at line 59 of file Multisites.php.

References $query, $res, $result, $ret, mDb, and BitBase::verifyId().

Here is the call graph for this function:

Multisites::insertRestriction

(

&$

pParamHash

)

Store content restriction

Parameters:

	$pParamHash	an array of restrictions to be stored.
	$pParamHash[multisite_id]	The id of the site to restrict to
	$pParamHash[content_id]	The id of the content to restrict

Returns:

bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why public

Definition at line 243 of file Multisites.php.

References $item, $pParamHash, $result, mDb, and verifyRestrictions().

Here is the call graph for this function:

Multisites::load

(

)

Load the currently active domain data from the db

Definition at line 33 of file Multisites.php.

References $_SERVER, $query, $res, $result, mDb, mInfo, mPrefs, and BitBase::verifyId().

Referenced by Multisites(), and store().

Here is the call graph for this function:

Multisites::Multisites

(

)

Initialisation of this class

Definition at line 25 of file Multisites.php.

References BitBase::BitBase(), and load().

Here is the call graph for this function:

Multisites::store

(

&$

pParamHash

)

Store / Update server data

Parameters:

array

pParams hash of values that will be used to store the page

Returns:

bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why public

Definition at line 113 of file Multisites.php.

References $pParamHash, $result, expungePreferences(), load(), mDb, verify(), and BitBase::verifyId().

Here is the call graph for this function:

Multisites::verify

(

&$

pParamHash

)

Make sure the data is safe to store

Parameters:

array

pParams reference to hash of values that will be used to store the page, they will be modified where necessary

Returns:

bool TRUE on success, FALSE if verify failed. If FALSE, $this->mErrors will have reason why private

Definition at line 145 of file Multisites.php.

References $pParamHash, $query, $result, description, mDb, and BitBase::verifyId().

Referenced by store().

Here is the call graph for this function:

Multisites::verifyRestrictions

(

&$

pParamHash

)

verify, clean up and prepare data to be stored

Parameters:

$pParamHash

all information that is being stored. will update $pParamHash by reference with fixed array of items

Returns:

bool TRUE on success, FALSE if store could not occur. If FALSE, $this->mErrors will have reason why private

Definition at line 262 of file Multisites.php.

References $item, $pParamHash, $tmp, tra(), and BitBase::verifyId().

Referenced by insertRestriction().

Here is the call graph for this function:

---

Member Data Documentation

Multisites::$mMultisiteId

id of the currently active domain

Definition at line 19 of file Multisites.php.

Multisites::$mPrefs

Definition at line 20 of file Multisites.php.

---

The documentation for this class was generated from the following file:

• Multisites.php

---