Inheritance diagram for ForumCat:

Static Public Member Functions
static	getListWithAreas ($seminar_id, $exclude_null=true)

static	getCategoryNameForArea ($topic_id)

static	add ($seminar_id, $name)

static	remove ($category_id, $seminar_id)

static	setPosition ($category_id, $pos)

static	addArea ($category_id, $area_id)

static	removeArea ($area_id)

static	setAreaPosition ($area_id, $pos)

static	setName ($category_id, $name)

static	get ($category_id)

static	getAreas ($category_id, $start=null, $num=20)

Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)

static	expireTableScheme ()

static	exists ($id)

static	countBySql ($sql='1', $params=[])

static	create ($data)

static	build ($data, $is_new=true)

static	buildExisting ($data)

static	import ($data)

static	findBySQL ($sql, $params=[])

static	findOneBySQL ($where, $params=[])

static	findThru ($foreign_key_value, $options)

static	findEachBySQL ($callable, $sql, $params=[])

static	findMany ($pks=[], $order='', $order_params=[])

static	findEachMany ($callable, $pks=[], $order='', $order_params=[])

static	findAndMapBySQL ($callable, $where, $params=[])

static	findAndMapMany ($callable, $pks=[], $order='', $order_params=[])

static	deleteBySQL ($where, $params=[])

static	toObject ($id_or_object)

static	__callStatic (string $name, array $arguments)

Static Protected Member Functions
static	configure ($config=[])

Static Protected Member Functions inherited from SimpleORMap
static	db_table ()

static	db_fields ()

static	pk ()

static	default_values ()

static	serialized_fields ()

static	alias_fields ()

static	i18n_fields ()

static	additional_fields ()

static	has_many ()

static	has_one ()

static	belongs_to ()

static	has_and_belongs_to_many ()

static	registered_callbacks ()

static	known_slots ()

static	notification_map ()

static	getter_setter_map ()

static	configure ($config=[])

static	config ($key)

static	registerCallback ($types, $cb)

static	unregisterCallback ($types, $cb)

Additional Inherited Members
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)

	__clone ()

	getRelationOptions ($relation)

	getTableMetadata ()

	hasAutoIncrementColumn ()

	setId ($id)

	getId ()

	getNewId ()

	toArray ($only_these_fields=null)

	toRawArray ($only_these_fields=null)

	toArrayRecursive ($only_these_fields=null)

	getValue ($field)

	getRelationValue ($relation, $field)

	getDefaultValue ($field)

	setValue ($field, $value)

	__get ($field)

	__set ($field, $value)

	__isset ($field)

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	getIterator ()

	count ()

	isField ($field)

	isRelation ($field)

	isAdditionalField ($field)

	isAliasField ($field)

	isI18nField ($field)

	setData ($data, $reset=false)

	isNew ()

	isDeleted ()

	setNew ($is_new)

	getWhereQuery ()

	restore ()

	store ()

	triggerChdate ()

	delete ()

	isDirty ()

	isFieldDirty ($field)

	revertValue ($field)

	getPristineValue ($field)

	initRelation ($relation)

	resetRelation ($relation)

	cleanup ()

Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Public Attributes inherited from SimpleORMap
static	$schemes = null

Protected Member Functions inherited from SimpleORMap
	_getId ($field)

	_setId ($field, $value)

	_getAdditionalValueFromRelation ($field)

	_setAdditionalValueFromRelation ($field, $value)

	_getAdditionalValue ($field)

	_setAdditionalValue ($field, $value)

	parseRelationOptions ($type, $name, $options)

	storeRelations ($only_these=null)

	deleteRelations ()

	initializeContent ()

	applyCallbacks ($type)

	cbNotificationMapper ($cb_type)

	cbAfterInitialize ($cb_type)

	setSerializedValue ($field, $value)

	setI18nValue ($field, $value)

Protected Attributes inherited from SimpleORMap
	$content = []

	$content_db = []

	$is_new = true

	$is_deleted = false

	$relations = []

	$additional_data = []

Static Protected Attributes inherited from SimpleORMap
static	$config = []

static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

static	$performs_batch_operation = false

Member Function Documentation

◆ add()

static add	(	$seminar_id,
		$name
	)

static

Adds a new category with the passed name to the passed seminar and returns the id of the newly created category

Parameters

string	$seminar_id
string	$name	the name of the new category

Returns: string the id of the newly created category

◆ addArea()

static addArea	(	$category_id,
		$area_id
	)

static

Add the passed area to the passed category and remove it from all other categories.

Parameters

string	$category_id	the ID of the category
string	$area_id	the ID of the area to add the category to

◆ configure()

static configure ( $config = [] )

staticprotected

Configures this model.

Parameters

array $config Configuration array

◆ get()

static get ( $category_id )

static

Return the data for the passed category_id

Parameters

string $category_id

Returns: array the data for the passed category_id

◆ getAreas()

static getAreas	(	$category_id,
		$start = `null`,
		$num = `20`
	)

static

Return the areas for the passed category_id

Parameters

string	$category_id
int	$start	limit start (optional)
int	$num	number of entries to fetch (optional, default is 20)

Returns: array the data for the passed category_id

◆ getCategoryNameForArea()

static getCategoryNameForArea ( $topic_id )

static

Returns the name of the associated category for an area denoted by the passed topic_id

Parameters

string $topic_id

Returns: string the name of the category

◆ getListWithAreas()

static getListWithAreas	(	$seminar_id,
		$exclude_null = `true`
	)

static

Return a list of all areas with their categories. Empty categories are excluded by default

Parameters

string	$seminar_id	the seminar_id the retrieve the categories for
string	$exclude_null	if false, empty categories are returned as well

Returns: array list of categories

◆ remove()

static remove	(	$category_id,
		$seminar_id
	)

static

Remove the category with the passed id. The seminar_id is used only to be certain.

Parameters

string	$category_id	The ID of the category to be deleted
string	$seminar_id	Seminar-ID the category belongs to

◆ removeArea()

static removeArea ( $area_id )

static

Remove the passed area from all categories.

Parameters

string $area_id the ID of the area to be removed

◆ setAreaPosition()

static setAreaPosition	(	$area_id,
		$pos
	)

static

Set the position for the passed category to the passed value

Parameters

string	$area_id	the ID of the area to update
int	$pos	the new position

◆ setName()

static setName	(	$category_id,
		$name
	)

static

Set the name for the passed category

Parameters

string	$category_id	the ID of the category to update
string	$name	the name to set

◆ setPosition()

static setPosition	(	$category_id,
		$pos
	)

static

Set the position for the passed category to the passed value

Parameters

string	$category_id	the ID of the category to update
int	$pos	the new position

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

lib/models/ForumCat.php

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ add()

◆ addArea()

◆ configure()

◆ get()

◆ getAreas()

◆ getCategoryNameForArea()

◆ getListWithAreas()

◆ remove()

◆ removeArea()

◆ setAreaPosition()

◆ setName()

◆ setPosition()