Adventure Documentation

NewsController extends PageCommonController
in package

This controller describes the behavior of News entities.

Use the controller to generate a collection of News entities.

Tags
see
News

Main entity of collection

see
FilesController

Associated files to News entities (type = 'news', id = $News->Id)

Table of Contents

__construct()  : mixed
getActiveDates()  : array<string|int, array<string|int, array<string|int, int>>>
Returns a list of the active dates for a specific Page of type 'news' with the count of entities per date, grouped by page, year, month. Useful to generate a menu/list sorted by years and months.
getDescription()  : string
Get the description of the entity
getNewsStoryCount()  : mixed
getTranslation()  : string
Get translation data

Methods

__construct()

public __construct([mixed $parseUriParameters = false ]) : mixed
Parameters
$parseUriParameters : mixed = false
Tags
Return values
mixed

getActiveDates()

Returns a list of the active dates for a specific Page of type 'news' with the count of entities per date, grouped by page, year, month. Useful to generate a menu/list sorted by years and months.

public getActiveDates([mixed $NewsId = null ]) : array<string|int, array<string|int, array<string|int, int>>>
Parameters
$NewsId : mixed = null
Tags
Return values
array<string|int, array<string|int, array<string|int, int>>>

Array grouped by page id, year and month

getDescription()

Get the description of the entity

public getDescription(mixed $Id[, mixed $LanguageIso = null ]) : string
Parameters
$Id : mixed
$LanguageIso : mixed = null
Tags
Return values
string

getNewsStoryCount()

public getNewsStoryCount([mixed $pageId = null ]) : mixed
Parameters
$pageId : mixed = null
Tags
Return values
mixed

getTranslation()

Get translation data

public getTranslation(mixed $Id, mixed $Title[, mixed $LanguageIso = null ][, mixed $Module = 'news' ]) : string
Parameters
$Id : mixed
$Title : mixed
$LanguageIso : mixed = null
$Module : mixed = 'news'
Tags
Return values
string

        

Search results