Class ArticleForumCollection

This class contains functions for dB manipulations and for the interaction between the frontend module content_user_forum and the backend plugin.

cGenericDb

cItemBaseAbstract

ItemCollection

ArticleForumCollection

Package: Plugin\UserForum
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Claus Schunk
Located at plugins/user_forum/classes/class.article_forum_collection.php

Methods summary
`public`	# `__construct( )` Throws `cDbException` `cInvalidArgumentException` Overrides `ItemCollection::__construct()`
`public array`	# `getAllCommentedArticles( )` Returns `array` Throws `cDbException`
`public`	# `deleteHierarchy( mixed $keyPost, mixed $level, mixed $idart, mixed $idcat, mixed $lang )` deletes comment with all subcomments from this comment deletes comment with all subcomments from this comment Parameters `$keyPost` `mixed` $keyPost `$level` `mixed` $level `$idart` `mixed` $idart `$idcat` `mixed` $idcat `$lang` `mixed` $lang Throws `cDbException` `cException` `cInvalidArgumentException`
`protected array`	# `_getCommentHierarchy( integer $id_cat, integer $id_art, integer $id_lang )` Parameters `$id_cat` `integer` $id_cat `$id_art` `integer` $id_art `$id_lang` `integer` $id_lang Returns `array` Throws `cDbException` `cException`
`public`	# `normalizeArray( array $arrforum, array & $result, integer $level = 0 )` Parameters `$arrforum` `array` $arrforum `$result` `array` $result `$level` `integer` $level
`public`	# `getTreeLevel( integer $id_cat, integer $id_art, integer $id_lang, array & $arrUsers, array & $arrforum, integer $parent = 0, boolean $frontend = false )` Parameters `$id_cat` `integer` $id_cat `$id_art` `integer` $id_art `$id_lang` `integer` $id_lang `$arrUsers` `array` $arrUsers `$arrforum` `array` $arrforum `$parent` `integer` $parent `$frontend` `boolean` $frontend Throws `cDbException`
`public`	# `updateValues( integer $id_user_forum, string $name, string $email, integer $like, integer $dislike, unknown_type $forum, integer $online )` Parameters `$id_user_forum` `integer` $id_user_forum `$name` `string` $name `$email` `string` $email `$like` `integer` $like `$dislike` `integer` $dislike `$forum` `unknown_type` $forum `$online` `integer` $online Throws `cDbException` `cException`
`public`	# `toggleOnlineState( integer $onlineState, integer $id_user_forum, integer $idart = NULL )` toggles the given input with update in db. toggles the given input with update in db. Parameters `$onlineState` `integer` $onlineState `$id_user_forum` `integer` $id_user_forum primary key `$idart` `integer` $idart article ID [optional] Throws `cDbException`
`public`	# `mailToModerator( mixed $realname, mixed $email, mixed $forum, mixed $idart, mixed $lang, integer $forum_quote = 0 )` email notification for registred moderator. before calling this function it is necessary to receive the converted language string from frontend module. Parameters `$realname` `mixed` $realname `$email` `mixed` $email `$forum` `mixed` $forum `$idart` `mixed` $idart `$lang` `mixed` $lang `$forum_quote` `integer` $forum_quote Throws `cDbException` `cException` `cInvalidArgumentException`
`public array`	# `getArticleTitle( integer $idart, integer $idlang )` Parameters `$idart` `integer` $idart `$idlang` `integer` $idlang Returns `array` Throws `cDbException`
`public array`	# `getExistingforum( )` Returns `array` Throws `cDbException` `cException`
`public array`	# `selectNameAndNameByForumId( integer $idquote )` Parameters `$idquote` `integer` $idquote Returns `array` Throws `cDbException` `cException`
`public boolean`	# `selectUser( mixed $userid )` Parameters `$userid` `mixed` $userid Returns `boolean` Throws `cDbException` `cException`
`public`	# `incrementLike( mixed $forum_user_id )` this function increments the actual value of likes from a comment and persists it. this function increments the actual value of likes from a comment and persists it. Parameters `$forum_user_id` `mixed` $forum_user_id int identifies a comment Throws `cDbException` `cException`
`public`	# `incrementDislike( mixed $forum_user_id )` this function inkrements the actual value of dislikes from a comment and persists it. this function inkrements the actual value of dislikes from a comment and persists it. Parameters `$forum_user_id` `mixed` $forum_user_id int identifies a comment Throws `cDbException` `cException`
`public`	# `insertValues( mixed $parent, mixed $idart, mixed $idcat, mixed $lang, mixed $userid, mixed $email, mixed $realname, mixed $forum, mixed $forum_quote )` persists a new comment created at the frontend module. persists a new comment created at the frontend module. Parameters `$parent` `mixed` $parent `$idart` `mixed` $idart `$idcat` `mixed` $idcat `$lang` `mixed` $lang `$userid` `mixed` $userid `$email` `mixed` $email `$realname` `mixed` $realname `$forum` `mixed` $forum `$forum_quote` `mixed` $forum_quote Throws `cDbException` `cException` `cInvalidArgumentException`
`public`	# `deleteAllCommentsById( integer $idart )` this function deletes all comments related to the same articleId this function deletes all comments related to the same articleId Parameters `$idart` `integer` $idart Throws `cDbException` `cInvalidArgumentException`
`public array`	# `getExistingforumFrontend( integer $id_cat, integer $id_art, integer $id_lang, boolean $frontend )` Parameters `$id_cat` `integer` $id_cat `$id_art` `integer` $id_art `$id_lang` `integer` $id_lang `$frontend` `boolean` $frontend Returns `array` Throws `cDbException` `cException`
`public string`	# `getModEmail( integer $idart )` returns the emailadress from the moderator for this article returns the emailadress from the moderator for this article Parameters `$idart` `integer` $idart Returns `string`
`public boolean`	# `getModModeActive( integer $idart )` returns if moderator mode is active for this article returns if moderator mode is active for this article Parameters `$idart` `integer` $idart Returns `boolean`
`public boolean`	# `getQuoteState( integer $idart )` returns if quotes for comments are allowed in this article returns if quotes for comments are allowed in this article Parameters `$idart` `integer` $idart Returns `boolean`
`public array`	# `readXML( )` This function loads and returns the xml content from the contentType aditionally the return array implies the articleId because of an easier mapping in the frontend. This function loads and returns the xml content from the contentType aditionally the return array implies the articleId because of an easier mapping in the frontend. Returns `array`
`public`	# `languageSync( array & $str )` this function is used to get translations from the language of the frontend module for example to generate the e-mail text with correct language settings. this function is used to get translations from the language of the frontend module for example to generate the e-mail text with correct language settings. Parameters `$str` `array` $str
`public array`	# `getlanguageSync( )` Returns `array`
`public array`	# `getCommentContent( integer $id_user_forum )` Parameters `$id_user_forum` `integer` $id_user_forum Returns `array` Throws `cException`
`protected integer\|boolean`	# `getIdUserForumContenType( )` Returns `integer\|boolean` Throws `cDbException`
`public array`	# `getUnmoderatedComments( )` Returns `array` Throws `cDbException`

Methods inherited from ItemCollection
_buildGroupWhereStatements(), _buildWhereStatements(), _delete(), _deleteMultiple(), _fetchJoinTables(), _findReverseJoinPartner(), _initializeDriver(), _recursiveStructuredFetch(), _resolveLinks(), _setItemClass(), _setJoinPartner(), addResultField(), copyItem(), count(), createNewItem(), delete(), deleteBy(), deleteByWhereClause(), deleteWhere(), deleteWhereGroup(), exists(), fetchArray(), fetchById(), fetchObject(), fetchTable(), flexSelect(), getAllIds(), getFieldsByWhereClause(), getIdsByWhereClause(), link(), loadItem(), next(), query(), queryAndFetchStructured(), removeResultField(), resetQuery(), select(), setEncoding(), setGroupCondition(), setInnerGroupCondition(), setLimit(), setOrder(), setWhere(), setWhereGroup()

Methods inherited from cItemBaseAbstract
`__get(), __set(), _getPropertiesCollectionInstance(), _getSecondDBInstance(), _resetItem(), _setLoaded(), _setPrimaryKeyName(), escape(), getPrimaryKeyName(), isLoaded()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties summary
`protected array`	`$cfg`	`0`	#
`protected cDb`	`$db`	`0`	#
`protected ArticleForumItem`	`$item`	`0`	#
`protected array`	`$languageSync`	`0`	#
`protected integer`	`$idContentType`	`0`	#

Properties inherited from ItemCollection
`$_JoinPartners, $_aOperators, $_bAllMode, $_collectionCache, $_driver, $_encoding, $_forwardJoinPartners, $_groupConditions, $_innerGroupConditions, $_itemClass, $_itemClassInstance, $_iteratorItem, $_lastSQL, $_limitCount, $_limitStart, $_links, $_order, $_resultFields, $_where, $_whereRestriction, $objects`

Properties inherited from cItemBaseAbstract
`$_className, $_loaded, $_oCache, $_primaryKeyName, $_settings, $lasterror, $properties, $secondDb, $table`

Packages

Classes

Class ArticleForumCollection

Throws

Overrides

Returns

Throws

Parameters

Throws

Parameters

Returns

Throws

Parameters

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Throws

Returns

Throws