LibertyQuota Class Reference

Inheritance diagram for LibertyQuota:

[legend]List of all members.

Public Member Functions
	assignQuotaToGroup ($pQuotaId, $pGroupId)
	getDisplayUrl ()
	getList ()
	getQuotaGroups ()
	getQuotaMenu ($pName='quota_menu', $pSelectId=NULL)
	getUserQuota ($pUserId)
	getUserUsage ($pUserId)
	isUserUnderQuota ($pUserId)
	isValid ()
	LibertyQuota ($pQuotaId=NULL, $pContentId=NULL)
	load ()
	store (&$pParamHash)
	verify (&$pParamHash)
Public Attributes
	$mQuotaId

---

Detailed Description

Definition at line 33 of file LibertyQuota.php.

---

Member Function Documentation

LibertyQuota::assignQuotaToGroup	(	$	pQuotaId,
		$	pGroupId
	)

Definition at line 155 of file LibertyQuota.php.

References $query, $rs, and mDb.

LibertyQuota::getDisplayUrl

(

)

Generates the URL to the quota page

Parameters:

pExistsHash

the hash that was returned by LibertyContent::pageExists

Returns:

the link to display the page.

Definition at line 234 of file LibertyQuota.php.

References $ret, and BitBase::verifyId().

Here is the call graph for this function:

LibertyQuota::getList

(

)

Definition at line 125 of file LibertyQuota.php.

References $query, $ret, and mDb.

LibertyQuota::getQuotaGroups

(

)

Definition at line 142 of file LibertyQuota.php.

References $sql, and mDb.

LibertyQuota::getQuotaMenu	(	$	pName = 'quota_menu',
		$	pSelectId = NULL
	)

Definition at line 134 of file LibertyQuota.php.

References $query, $ret, $rs, and mDb.

LibertyQuota::getUserQuota

(

$

pUserId

)

Given a user_id, this will return the max quota for the given user. If the user belongs to more than one group, it will chose the max values

Parameters:

pUserId

user_id of the user for usage to be calculated for

Returns:

an integer of the total bytes used

Definition at line 201 of file LibertyQuota.php.

References $query, $ret, and mDb.

LibertyQuota::getUserUsage

(

$

pUserId

)

Given a user_id, this will return this disk space used for the given user

Parameters:

pUserId

user_id of the user for usage to be calculated for

Returns:

an integer of the total bytes used

Definition at line 220 of file LibertyQuota.php.

References $ret, and mDb.

Referenced by isUserUnderQuota().

LibertyQuota::isUserUnderQuota

(

$

pUserId

)

returns the quota and consumption if a user is under usage level

Definition at line 175 of file LibertyQuota.php.

References $diskQuota, $query, $ret, $rs, FALSE, getUserUsage(), and mDb.

Here is the call graph for this function:

LibertyQuota::isValid

(

)

Definition at line 242 of file LibertyQuota.php.

References BitBase::verifyId().

Here is the call graph for this function:

LibertyQuota::LibertyQuota	(	$	pQuotaId = NULL,
		$	pContentId = NULL
	)

During initialisation, be sure to call our base constructors

Definition at line 43 of file LibertyQuota.php.

References LibertyBase::LibertyBase().

Here is the call graph for this function:

LibertyQuota::load

(

)

Load the data from the database

Parameters:

pParamHash

be sure to pass by reference in case we need to make modifcations to the hash

Definition at line 105 of file LibertyQuota.php.

References $query, $result, $rs, mDb, and mInfo.

Referenced by store().

LibertyQuota::store

(

&$

pParamHash

)

Any method named Store inherently implies data will be written to the database

Parameters:

pParamHash

be sure to pass by reference in case we need to make modifcations to the hash

Definition at line 53 of file LibertyQuota.php.

References $pParamHash, $result, load(), mDb, and verify().

Here is the call graph for this function:

LibertyQuota::verify

(

&$

pParamHash

)

Make sure the data is safe to store

Parameters:

pParamHash

be sure to pass by reference in case we need to make modifcations to the hash

Definition at line 74 of file LibertyQuota.php.

References $pParamHash, description, and title.

Referenced by store().

---

Member Data Documentation

LibertyQuota::$mQuotaId

Primary key for our mythical Quota class object & table

Definition at line 38 of file LibertyQuota.php.

---

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

• LibertyQuota.php

---