BlogPostParametersGroup
extends ParametersGroup
in package
Uses
CatalogItemsParametersGroupTrait, SortableItemsParametersGroupTrait, PaginableItemsParametersGroupTrait
This is the blog model (blog posts resources) parameters group class.
Table of Contents
| $bloggerId | : int | |
|---|---|---|
| $categoryId | : int | |
| $fromDate | : string | |
| $idList | : string | |
| $page | : int | |
| $perPage | : int | |
| $pId | : string | |
| $q | : string | |
| $randomItems | : int | |
| $sort | : string | |
| $sortByIdList | : string | |
| $tagId | : int | |
| $toDate | : string | |
| $validator | : ParametersValidator | |
| setBloggerId() | Sets the blogger internal identifier parameter for this parameters group. | : void |
| setCategoryId() | Sets the category internal identifier parameter for this parameters group. | : void |
| setFromDate() | Sets a start date for this parameters group. | : void |
| setIdList() | Sets a list of internal identifiers for this parameters group. | : void |
| setPage() | Sets the page parameter for this parameters group. | : void |
| setPerPage() | Sets the per page parameter for this parameters group. | : void |
| setPId() | Sets the public identifier parameter for this parameters group. | : void |
| setQ() | Sets a search query parameter for this parameters group. | : void |
| setRandomItems() | Sets the random items parameter for this parameters group. | : void |
| setSort() | Sets the sort criteria parameter for this parameters group. | : void |
| setSortByIdList() | Sets a list of internal identifiers as a sort criteria parameter for this parameters group. | : void |
| setTagId() | Sets the tag internal identifier parameter for this parameters group. | : void |
| setToDate() | Sets a end date for this parameters group. | : void |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | : BlogPostParametersValidator |
Properties
$bloggerId
protected
int
$bloggerId
$categoryId
protected
int
$categoryId
$fromDate
protected
string
$fromDate
$idList
protected
string
$idList
$page
protected
int
$page
$perPage
protected
int
$perPage
$pId
protected
string
$pId
$q
protected
string
$q
$randomItems
protected
int
$randomItems
$sort
protected
string
$sort
$sortByIdList
protected
string
$sortByIdList
$tagId
protected
int
$tagId
$toDate
protected
string
$toDate
$validator
protected
ParametersValidator
$validator
Methods
setBloggerId()
Sets the blogger internal identifier parameter for this parameters group.
public
setBloggerId(int $bloggerId) : void
Parameters
- $bloggerId : int
Return values
void —setCategoryId()
Sets the category internal identifier parameter for this parameters group.
public
setCategoryId(int $categoryId) : void
Parameters
- $categoryId : int
Return values
void —setFromDate()
Sets a start date for this parameters group.
public
setFromDate(DateTime $fromDate) : void
Parameters
- $fromDate : DateTime
Return values
void —setIdList()
Sets a list of internal identifiers for this parameters group.
public
setIdList(string $idList) : void
Parameters
- $idList : string
Return values
void —setPage()
Sets the page parameter for this parameters group.
public
setPage(int $page) : void
Parameters
- $page : int
Return values
void —setPerPage()
Sets the per page parameter for this parameters group.
public
setPerPage(int $perPage) : void
Parameters
- $perPage : int
Return values
void —setPId()
Sets the public identifier parameter for this parameters group.
public
setPId(string $pId) : void
Parameters
- $pId : string
Return values
void —setQ()
Sets a search query parameter for this parameters group.
public
setQ(string $q) : void
Parameters
- $q : string
Return values
void —setRandomItems()
Sets the random items parameter for this parameters group.
public
setRandomItems(int $randomItems) : void
Parameters
- $randomItems : int
Return values
void —setSort()
Sets the sort criteria parameter for this parameters group.
public
setSort(string $sort) : void
Parameters
- $sort : string
Return values
void —setSortByIdList()
Sets a list of internal identifiers as a sort criteria parameter for this parameters group.
public
setSortByIdList(string $sortByIdList) : void
Parameters
- $sortByIdList : string
Return values
void —setTagId()
Sets the tag internal identifier parameter for this parameters group.
public
setTagId(int $tagId) : void
Parameters
- $tagId : int
Return values
void —setToDate()
Sets a end date for this parameters group.
public
setToDate(DateTime $toDate) : void
Parameters
- $toDate : DateTime
Return values
void —toArray()
Returns the object data on array format.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —filter()
protected
filter(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstantiatedValidator()
protected
getInstantiatedValidator() : ParametersValidator
Return values
ParametersValidator —getValidator()
protected
getValidator() : BlogPostParametersValidator