PHP Class RainLab\Blog\Components\Posts

Inheritance: extends Cms\Classes\ComponentBase
Show file Open project: rainlab/blog-plugin

Public Properties

Property Type Description
$category Model If the post list should be filtered by a category, the model to use.
$categoryPage string Reference to the page name for linking to categories.
$noPostsMessage string Message to display when there are no messages.
$pageParam string Parameter to use for the page number
$postPage string Reference to the page name for linking to posts.
$posts Collection A collection of posts to display
$sortOrder string If the post list should be ordered by another attribute.

Public Methods

Method Description
componentDetails ( )
defineProperties ( )
getCategoryPageOptions ( )
getPostPageOptions ( )
getSortOrderOptions ( )
onRun ( )

Protected Methods

Method Description
listPosts ( )
loadCategory ( )
prepareVars ( )

Method Details

componentDetails() public method

public componentDetails ( )

defineProperties() public method

public defineProperties ( )

getCategoryPageOptions() public method

public getCategoryPageOptions ( )

getPostPageOptions() public method

public getPostPageOptions ( )

getSortOrderOptions() public method

public getSortOrderOptions ( )

listPosts() protected method

protected listPosts ( )

loadCategory() protected method

protected loadCategory ( )

onRun() public method

public onRun ( )

prepareVars() protected method

protected prepareVars ( )

Property Details

$category public property

If the post list should be filtered by a category, the model to use.
public Model $category
return Model

$categoryPage public property

Reference to the page name for linking to categories.
public string $categoryPage
return string

$noPostsMessage public property

Message to display when there are no messages.
public string $noPostsMessage
return string

$pageParam public property

Parameter to use for the page number
public string $pageParam
return string

$postPage public property

Reference to the page name for linking to posts.
public string $postPage
return string

$posts public property

A collection of posts to display
public Collection $posts
return Collection

$sortOrder public property

If the post list should be ordered by another attribute.
public string $sortOrder
return string