Class: Multisites

Source Location: d:\website\PhpDocumentor\/multisites/Multisites.php

Class Overview

BitBase
   |
   --Multisites

Multisite Management

Variables

Methods

Inherited Variables

Class: BitBase

BitBase::$dType
BitBase::$mCacheTime
BitBase::$mDb
BitBase::$mErrors
BitBase::$mInfo
BitBase::$mLogs
BitBase::$mName
BitBase::$mSuccess

Inherited Methods

Class: BitBase

BitBase::BitBase(): During initialisation, we assign a name which is used by the class.
BitBase::debug(): Switch debug level in database
BitBase::display(): This method should be THE method used to display a template. php files should not access $gBitSmarty directly.
BitBase::getDb(): Return pointer to current Database
BitBase::getField(): Returns entry from the mInfo hash if field exists
BitBase::isDatabaseValid(): Determines if there is a valide database connection
BitBase::prepGetList(): Prepares parameters with default values for any getList function
BitBase::setDatabase(): Sets database mechanism for the instance
BitBase::verifyId(): Determines if any given variable exists and is a number

Class Details

[line 15]
Multisite Management

[ Top ]

Class Variables

$mMultisiteId =

[line 19]

id of the currently active domain

Type:

mixed

[ Top ]

$mPrefs =

[line 20]

Type:

mixed

[ Top ]

Class Methods

constructor Multisites [line 25]

Multisites Multisites(
)

Initialisation of this class

[ Top ]

method expunge [line 189]

void expunge(
[$pMultisiteId
$pMultisiteId = NULL])

remove server from db

Tags:

access:

public

Parameters:

$pMultisiteId

$pMultisiteId

is the id of the server we need to delete

[ Top ]

method expungeRestrictions [line 206]

void expungeRestrictions(
$pMultisiteId
$pMultisiteId, [
$pContentId = NULL])

remove restrictions by multisite_id from db

Tags:

access:

public

Parameters:

$pMultisiteId	$pMultisiteId
	$pContentId

[ Top ]

method getMultisites [line 59]

void getMultisites(
[if
$pMultisiteId = NULL], [if
$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

[ Top ]

method insertRestriction [line 243]

bool insertRestriction(
$pParamHash
&$pParamHash, $pParamHash[multisite_id]
1, $pParamHash[content_id]
2)

Store content restriction

Tags:

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

Parameters:

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

[ Top ]

method load [line 33]

void load(
)

Load the currently active domain data from the db

[ Top ]

method store [line 113]

bool store(
array
&$pParamHash)

Store / Update server data

Tags:

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

Parameters:

array

&$pParamHash

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

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:45:55 +0000 by phpDocumentor 1.3.0