PHP Class DiscussionsModule, vanilla

Inheritance: extends Gdn_Module

Show file Open project: vanilla/vanilla Class Usage Examples

Public Properties

Property	Type	Description
$Limit		Display limit.
$Prefix	string

Protected Properties

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

Public Methods

Method	Description
__construct ( )
assetTarget ( )
getCategoryIDs ( ) : array	Get a list of category IDs to limit.
getData ( integer \| boolean $limit = false )	Get the data for the module.
getShowPhotos ( ) : boolean
setCategoryIDs ( array $categoryIDs )	Set a list of category IDs to limit.
setShowPhotos ( $showPhotos ) : DiscussionsModule
toString ( )

Method Details

__construct() public method

public __construct ( )

assetTarget() public method

public assetTarget ( )

getCategoryIDs() public method

Get a list of category IDs to limit.

public getCategoryIDs ( ) : array
return	array

getData() public method

Get the data for the module.

public getData ( integer \| boolean $limit = false )
$limit	integer \| boolean	Override the number of discussions to display.

getShowPhotos() public method

public getShowPhotos ( ) : boolean
return	boolean	Whether to show the discussion author avatar.

setCategoryIDs() public method

Set a list of category IDs to limit.

public setCategoryIDs ( array $categoryIDs )
$categoryIDs	array

setShowPhotos() public method

public setShowPhotos ( $showPhotos ) : DiscussionsModule
$showPhotos		Whether to show the discussion author avatar.
return	DiscussionsModule

toString() public method

public toString ( )

Property Details

$Limit public property

Display limit.

public $Limit

$Prefix public property

public string $Prefix
return	string

$categoryIDs protected property

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

protected $categoryIDs