Class: Categories

Source Location: /objects.php

Class Categories

Class Overview

This class deals with the categories

Located in /objects.php [line 1583]

BaseConfig
   |
   --Categories

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From BaseConfig

BaseConfig::$changed

BaseConfig::$configfile

BaseConfig::$data

BaseConfig::$upgraded

Inherited From BaseConfig

BaseConfig::__construct()

Constructor

BaseConfig::count()

Return configuration-array size

BaseConfig::fixConfig()

Fix configuration (this should be overwritten in subclass)

BaseConfig::initConfig()

Initialise configuration after has been read, fixed and organized.

BaseConfig::loadConfig()

Load and verify config

BaseConfig::organizeConfig()

Organize configuration

BaseConfig::print_r()

Print a comprehensible representation of the users

BaseConfig::save()

Old save version

BaseConfig::saveConfig()

Save configuration if 'safe' to do so

BaseConfig::setChanged()

Set changed flag

BaseConfig::setUpgraded()

Set upgraded

BaseConfig::verifyConfig()

Verify configuration (this should be overwritten in subclass)

[ Top ]

Method Summary

Categories	Categories()
Categories	__construct()
void	allowedCategories()	Get a list of categories the user is allowed to post into
void	allowUser()	Allow a user to post in this category
void	deleteCategory()	Delete a single category
void	disallowUser()	Disallow a user to post in this category
void	fixConfig()
array	getCategories()	Get an array with all the categories. We filter the users to make sure we only return users that still exist
array	getCategory()	Get a single category
array	getCategorynames()	Get a list of all category names
array	getSearchCategorynames()	Get a list of all category names in which we should NOT search
boolean	isCategory()	Check if a given $name is a category.
void	organizeConfig()
void	readOld()
void	saveCategories()	Old save function
void	setCategory()	change the settings for an existing category, or modify an existing one.
int	sort()	Sort the categories based on the order and string comparison of display name if order is identical.
void	verifyConfig()

[ Top ]

Properties

Methods

Constructor Categories [line 1588]

Categories Categories(
)

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 1584]

Categories __construct(
)

API Tags:

Access:

public

Redefinition of:

BaseConfig::__construct(): Constructor

[ Top ]

allowedCategories [line 1804]

void allowedCategories(

$username 
)

Get a list of categories the user is allowed to post into

Parameters:

$username:

[ Top ]

allowUser [line 1826]

void allowUser(
string
$catname, string
$username 
)

Allow a user to post in this category

Parameters:

string	$catname:
string	$username:

[ Top ]

deleteCategory [line 1955]

void deleteCategory(
string
$name 
)

Delete a single category

Parameters:

string

$name:

[ Top ]

disallowUser [line 1852]

void disallowUser(
string
$catname, string
$username 
)

Disallow a user to post in this category

Parameters:

string	$catname:
string	$username:

[ Top ]

fixConfig [line 1600]

void fixConfig(
)

API Tags:

Access:

protected

Redefinition of:

BaseConfig::fixConfig(): Fix configuration (this should be overwritten in subclass)

[ Top ]

getCategories [line 1775]

array getCategories(
)

Get an array with all the categories. We filter the users to make sure we only return users that still exist

[ Top ]

getCategory [line 1879]

array getCategory(
string
$name 
)

Get a single category

Parameters:

string

$name:

[ Top ]

getCategorynames [line 1898]

array getCategorynames(
)

Get a list of all category names

[ Top ]

getSearchCategorynames [line 1933]

array getSearchCategorynames(
)

Get a list of all category names in which we should NOT search

[ Top ]

isCategory [line 1916]

boolean isCategory(
string
$name 
)

Check if a given $name is a category.

Parameters:

string

$name:

[ Top ]

organizeConfig [line 1620]

void organizeConfig(
)

API Tags:

Access:

protected

Redefinition of:

BaseConfig::organizeConfig(): Organize configuration

[ Top ]

readOld [line 1657]

void readOld(
)

API Tags:

Access:

protected

[ Top ]

saveCategories [line 1653]

void saveCategories(
)

Old save function

API Tags:

Access:

public

[ Top ]

setCategory [line 1744]

void setCategory(
string
$name, array
$cat 
)

change the settings for an existing category, or modify an existing one.

Parameters:

string	$name:
array	$cat:

[ Top ]

sort [line 1634]

int sort(
array
$a, array
$b 
)

Sort the categories based on the order and string comparison of display name if order is identical.

Parameters:

array	$a:
array	$b:

[ Top ]

verifyConfig [line 1592]

void verifyConfig(
)

API Tags:

Access:

protected

Redefinition of:

BaseConfig::verifyConfig(): Verify configuration (this should be overwritten in subclass)

[ Top ]

Documentation generated on Tue, 07 Feb 2012 01:07:24 +0100 by phpDocumentor 1.4.3

	pivotx

[ class tree: pivotx ] [ index: pivotx ] [ all elements ]