프로퍼티 | 타입 | 설명 | |
---|---|---|---|
$BodyLimit | How many chars of Body to return. | ||
$ContentType | What type of content to fetch. One of: all, discussions, comments. | ||
$Expiry | How long do we cache in seconds. | ||
$Group | How often should we encapsulate content in groups. Groups of: n. | ||
$Limit | How much content should be fetched. | ||
$Properties | Whitelist of accepted parameters. | ||
$Selection | Parameters for the selector method. | ||
$Selector | How should we choose the content? - role Author's Role - rank Author's Rank - category Content's Category - score Content's Score - promoted | ||
$TitleLimit | How many chars of Title to return. |
메소드 | 설명 | |
---|---|---|
__construct ( ) | ||
assetTarget ( ) : string | Default asset target for this module. | |
getData ( ) | Get data based on class properties. | |
load ( array $Parameters = [] ) | Set class properties. | |
showComments ( ) : boolean | Whether to display promoted comments. | |
showDiscussions ( ) : boolean | Whether to display promoted discussions. | |
toString ( ) : string | Render. | |
validate ( array $Parameters = [] ) : string | true | Validate data to be used as class properties. |
메소드 | 설명 | |
---|---|---|
condense ( array &$Content, array $Limit ) | Condense an interleaved content list down to the required size | |
joinCategory ( array &$Comments ) | Attach CategoryID to Comments | |
processContent ( Array &$content ) | Pre-process content into a uniform format for output | |
security ( array &$Content ) | Strip out content that this user is not allowed to see | |
securityFilter ( $ContentItem ) : boolean | Determine if we have permission to view this content. | |
selectByCategory ( array | integer $Parameters ) : array | false | Select content based on its CategoryID. | |
selectByPromoted ( array $Parameters ) : array | false | Selected content that passed the Promoted threshold. | |
selectByRank ( array | integer $Parameters ) : array | false | Select content based on author RankID. | |
selectByRole ( array | integer $Parameters ) : array | false | Select content based on author RoleID. | |
selectByScore ( array | integer $Parameters ) : array | false | Select content based on its Score. | |
union ( string $Field, array $Sections ) : array | Interleave two or more result arrays by a common field |
public assetTarget ( ) : string | ||
리턴 | string |
protected joinCategory ( array &$Comments ) | ||
$Comments | array |
protected processContent ( Array &$content ) | ||
$content | Array | By reference |
protected securityFilter ( $ContentItem ) : boolean | ||
$ContentItem | ||
리턴 | boolean |
protected selectByPromoted ( array $Parameters ) : array | false | ||
$Parameters | array | Not used. |
리턴 | array | false | $Content |
public showComments ( ) : boolean | ||
리턴 | boolean |
public showDiscussions ( ) : boolean | ||
리턴 | boolean |
public $ContentType |
public $Selector |