Legacy_iCategoryDelegate Interface Reference

Static Public Member Functions
static	getTitle (&$title, $catDir, $catId)
static	getTree (&$tree, $catDir, $authType, $catId=0, $module=null)
static	getTitleList (&$titleList, $catDir)
static	hasPermission (&$check, $catDir, $catId, $authType, $module=null)
static	getParent (&$parent, $catDir, $catId)
static	getChildren (&$children, $catDir, $catId, $authType, $module=null)
static	getCatPath (&$catPath, $catDir, $catId, $order='ASC')
static	getPermittedIdList (&$idList, $catDir, $authType, $uid, $catId=0, $module=null)

Detailed Description

Interface of category delegate

Definition at line 19 of file CategoryDelegateInterface.class.php.

Member Function Documentation

getCatPath()

static getCatPath ( & $catPath, $catDir, $catId, $order = 'ASC' )

static

getCatPath Legacy_Category.{dirname}.GetCatPath get category path array from top to the given category.

Parameters

string[]	&$catPath	$catPath['cat_id'] $catPath['title']
string	$catDir	category module's dirname
int	$catId	terminal category id in the category path
string	$order	'ASC' or 'DESC'

Returns

void

Parameters

$catPath	* array **
$catDir	* string **
$catId	* int **
$order	* string **

getChildren()

static getChildren ( & $children, $catDir, $catId, $authType, $module = null )

static

getChildren Legacy_Category.{dirname}.GetChildren get the child category objects. Be careful that you can get only children objects, excluded the given category itself.

Parameters

Legacy_AbstractCategoryObject[]	&$children
string	$catDir	category module's dirname
int	$catId	the parent's category id
string	$authType	ex) viewer, editor, manager
string	$module	module confinement

Returns

void

Parameters

$children	* Legacy_AbstractCategoryObject[] **
$catDir	* string **
$catId	* int **
$authType	* string **
$module	* string **

getParent()

static getParent ( & $parent, $catDir, $catId )

static

getParent Legacy_Category.{dirname}.GetParent get the parent category object.

Parameters

Legacy_AbstractCategoryObject	&$parent
string	$catDir	category module's dirname
int	$catId	category id

Returns

void

Parameters

$parent	* Legacy_AbstractCategoryObject **
$catDir	* string **
$catId	* int **

getPermittedIdList()

static getPermittedIdList ( & $idList, $catDir, $authType, $uid, $catId = 0, $module = null )

static

getPermittedIdList Legacy_Category.{dirname}.GetPermittedIdList get category ids of permission.

Parameters

int[]	&$idList
string	$catDir	category module's dirname
string	$authType	ex) viewer, editor, manager
int	$uid
int	$catId	get result under this cat_id
string	$module	module confinement

Returns

void

Parameters

$idList	* int[] **
$catDir	* string **
$authType	* string **
$uid	* int **
$catId	* int **
$module	* string **

getTitle()

static getTitle ( & $title, $catDir, $catId )

static

getTitle Legacy_Category.{dirname}.GetTitle

Parameters

string	&$title	category title
string	$catDir	category module's directory name
int	$catId	category id

Returns

void

Parameters

$title	* string **
$catDir	* string **
$catId	* int **

getTitleList()

static getTitleList ( & $titleList, $catDir )

static

getTitleList Legacy_Category.{dirname}.GetTitleList

Parameters

string	&$titleList	category title array
string	$catDir	category module's dirname

Returns

void

Parameters

$titleList	* string[] **
$catDir	* string **

getTree()

static getTree ( & $tree, $catDir, $authType, $catId = 0, $module = null )

static

getTree Legacy_Category.{dirname}.GetTree Get category Legacy_AbstractCategoryObject array in parent-child tree order

Parameters

Legacy_AbstractCategoryObject[]	$tree
string	$catDir	category module's dirname
string	$authType	ex) viewer, editor, manager
int	$catId	get tree under this cat_id
string	$module	module confinement

Returns

void

Parameters

$tree	* Legacy_AbstractCategoryObject[] **
$catDir	* string **
$authType	* string **
$catId	* int **
$module	* string **

hasPermission()

static hasPermission ( & $check, $catDir, $catId, $authType, $module = null )

static

hasPermission Legacy_Category.{dirname}.HasPermission

Parameters

bool	&$check
string	$catDir	category module's dirname
int	$catId	category id
string	$authType	ex) viewer, editor, manager
string	$module	module confinement

Returns

void

Parameters

$check	* bool **
$catDir	* string **
$catId	* int **
$authType	* string **
$module	* string **

---

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

• html/modules/legacy/class/interface/CategoryDelegateInterface.class.php