PHP Класс DiscussionsController, vanilla

Наследование: extends ProjectController
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$Category Category object. Used to limit which discussions are returned to a particular category.
$CategoryID Unique identifier for category.
$ShowOptions Value indicating if discussion options should be displayed when rendering the discussion view.
$Uses to include.

Защищенные свойства (Protected)

Свойство Тип Описание
$categoryIDs Limit the discussions to just this list of categories, checked for view permission.

Открытые методы

Метод Описание
bookmarked ( $Page = '0' ) Display discussions the user has bookmarked.
bookmarkedPopin ( )
getCategoryIDs ( ) : array
getCommentCounts ( ) Takes a set of discussion identifiers and returns their comment counts in the same order.
index ( integer $Page = false ) Default all discussions view: chronological by most recent comment.
initialize ( ) Highlight route and include JS, CSS, and modules used by all methods.
mine ( $Page = 'p1' ) Display discussions started by the user.
promoted ( ) Endpoint for the PromotedContentModule's data.
setCategoryIDs ( array $categoryIDs )
sort ( string $Target = '' ) Set user preference for sorting discussions.
table ( integer $Page = '0' ) "Table" layout for discussions. Mimics more traditional forum discussion layout.
unread ( $Page = '0' )
userBookmarkCount ( $UserID = false )

Описание методов

bookmarked() публичный Метод

Display discussions the user has bookmarked.
С версии: 2.0.0
public bookmarked ( $Page = '0' )

bookmarkedPopin() публичный Метод

public bookmarkedPopin ( )

getCategoryIDs() публичный Метод

public getCategoryIDs ( ) : array
Результат array

getCommentCounts() публичный Метод

Takes a set of discussion identifiers and returns their comment counts in the same order.
public getCommentCounts ( )

index() публичный Метод

Default all discussions view: chronological by most recent comment.
С версии: 2.0.0
public index ( integer $Page = false )
$Page integer Multiplied by PerPage option to determine offset.

initialize() публичный Метод

Always called by dispatcher before controller's requested method.
С версии: 2.0.0
public initialize ( )

mine() публичный Метод

Display discussions started by the user.
С версии: 2.0.0
public mine ( $Page = 'p1' )

promoted() публичный Метод

Parameters & values must be lowercase and via GET.
См. также: PromotedContentModule
public promoted ( )

setCategoryIDs() публичный Метод

public setCategoryIDs ( array $categoryIDs )
$categoryIDs array

sort() публичный Метод

Set user preference for sorting discussions.
public sort ( string $Target = '' )
$Target string The target to redirect to.

table() публичный Метод

"Table" layout for discussions. Mimics more traditional forum discussion layout.
public table ( integer $Page = '0' )
$Page integer Multiplied by PerPage option to determine offset.

unread() публичный Метод

Устаревший: since 2.3
public unread ( $Page = '0' )

userBookmarkCount() публичный Метод

public userBookmarkCount ( $UserID = false )

Описание свойств

$Category публичное свойство

Category object. Used to limit which discussions are returned to a particular category.
public $Category

$CategoryID публичное свойство

Unique identifier for category.
public $CategoryID

$ShowOptions публичное свойство

Value indicating if discussion options should be displayed when rendering the discussion view.
public $ShowOptions

$Uses публичное свойство

to include.
public $Uses

$categoryIDs защищенное свойство

Limit the discussions to just this list of categories, checked for view permission.
protected $categoryIDs