NewsService extends NewsService
in package
Uses ServiceTrait

This is the NewsService class.

Remember that a service is an extension of a SDK model that allows to add additional actions to a model request or create new methods to simplify some common requests. In this case, the NewsService extends the SDK\Services\NewsService.

Tags
see
NewsService::getNewsById()
see
NewsService::getNewsByIdList()
see
NewsService::getNewsByPId()
see
NewsService::getNewsBySearchCriteria()
see
NewsService::addGetNewsById()
see
NewsService::addGetNewsByIdList()
see
NewsService::addGetNewsByPId()
see
NewsService::addGetNewsBySearchCriteria()
see
NewsService

Table of Contents

addGetNewsById() This method adds the batch request to get the 'new' whose id matches the given one.  : void
addGetNewsByIdList() This method adds the batch request to get those 'news' whose id matches any of the given idList.  : void
addGetNewsByPId() This method adds the batch request to get the 'new' whose pId matches the given one.  : void
addGetNewsBySearchCriteria() This method adds the batch request to get those 'news' that match the given search criteria.  : void
buildElementCollection() This method returns and ElementCollection from the given data and class  : bool
generateParametersGroupFromArray() This method sets a parametersGroup object with the filters indicated in params (array key=>value).  : array<string|int, mixed>
getNewsById() This method returns the Dto of the 'new' whose id matches the given one.  : News|null
getNewsByIdList() This method returns the Dtos of those 'news' whose id matches any of the given list.  : ElementCollection|null
getNewsByPId() This method returns the Dto of the 'new' whose pId matches the given one.  : News|null
getNewsBySearchCriteria() This method returns the Dtos of those 'news' whose search criteria matches the given one.  : ElementCollection|null
validateParameterGroup() This method validates the given parametersGroup. Returns true if valid, false otherwise.  : bool
getAllElementCollectionItems() Returns all available items filtered with the given parameters  : ElementCollection|null

Methods

addGetNewsById()

This method adds the batch request to get the 'new' whose id matches the given one.

public addGetNewsById(BatchRequests $batchRequests, string $batchName, int $id) : void
Parameters
$batchRequests : BatchRequests
$batchName : string

the name that will identify the request on the batch return.

$id : int
Return values
void —

addGetNewsByIdList()

This method adds the batch request to get those 'news' whose id matches any of the given idList.

public addGetNewsByIdList(BatchRequests $batchRequests, string $batchName, string $idList) : void
Parameters
$batchRequests : BatchRequests
$batchName : string

the name that will identify the request on the batch return.

$idList : string
Return values
void —

addGetNewsByPId()

This method adds the batch request to get the 'new' whose pId matches the given one.

public addGetNewsByPId(BatchRequests $batchRequests, string $batchName, string $pId) : void
Parameters
$batchRequests : BatchRequests
$batchName : string

the name that will identify the request on the batch return.

$pId : string
Return values
void —

addGetNewsBySearchCriteria()

This method adds the batch request to get those 'news' that match the given search criteria.

public addGetNewsBySearchCriteria(BatchRequests $batchRequests, string $batchName, string $searchCriteria) : void
Parameters
$batchRequests : BatchRequests
$batchName : string

the name that will identify the request on the batch return.

$searchCriteria : string
Return values
void —

buildElementCollection()

This method returns and ElementCollection from the given data and class

public buildElementCollection(array<string|int, mixed> $data, string $class) : bool
Parameters
$data : array<string|int, mixed>
$class : string
Return values
bool —

generateParametersGroupFromArray()

This method sets a parametersGroup object with the filters indicated in params (array key=>value).

public generateParametersGroupFromArray(ParametersGroup &$parametersGroup, array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$parametersGroup : ParametersGroup
$params : array<string|int, mixed>
Return values
array<string|int, mixed> —

with the applied filters

getNewsById()

This method returns the Dto of the 'new' whose id matches the given one.

public getNewsById(int $id) : News|null
Parameters
$id : int
Return values
News|null —

getNewsByIdList()

This method returns the Dtos of those 'news' whose id matches any of the given list.

public getNewsByIdList(string $idList) : ElementCollection|null
Parameters
$idList : string
Return values
ElementCollection|null —

getNewsByPId()

This method returns the Dto of the 'new' whose pId matches the given one.

public getNewsByPId(string $pId) : News|null
Parameters
$pId : string
Return values
News|null —

getNewsBySearchCriteria()

This method returns the Dtos of those 'news' whose search criteria matches the given one.

public getNewsBySearchCriteria(string $searchCriteria) : ElementCollection|null
Parameters
$searchCriteria : string
Return values
ElementCollection|null —

validateParameterGroup()

This method validates the given parametersGroup. Returns true if valid, false otherwise.

public validateParameterGroup(ParametersGroup $parametersGroup) : bool
Parameters
$parametersGroup : ParametersGroup
Return values
bool —

getAllElementCollectionItems()

Returns all available items filtered with the given parameters

protected getAllElementCollectionItems(string $elementClass, string $resource, ParametersGroup $params) : ElementCollection|null
Parameters
$elementClass : string
$resource : string
$params : ParametersGroup

object with the needed filters to send to the API resource

Return values
ElementCollection|null —

Search results