1. class
  2. CWP
  3. \
  4. CWP
  5. \
  6. PageTypes
  7. \
  8. NewsHolder

NewsHolder

class NewsHolder extends DatedUpdateHolder (View source)

Properties

Methods

public
UpdateTags()

Find all distinct tags (TaxonomyTerms) associated with the DatedUpdatePages under this holder.

from  DatedUpdateHolder
public
Updates($tagID = null, $dateFrom = null, $dateTo = null, $year = null, $monthNumber = null)

Wrapper to find all updates belonging to this holder, based on some filters.

from  DatedUpdateHolder
public static 
AllUpdates(string $className = NewsPage::class, int|null $parentID = null, int|null $tagID = null, string|null $dateFrom = null, string|null $dateTo = null, int|null $year = null, int|null $monthNumber = null)

Find all site's news items, based on some filters.

public static 
ExtractMonths(DataList $updates, string $link = null, int $currentYear = null, int $currentMonthNumber = null)

Produce an ArrayList of available months out of the updates contained in the DataList.

from  DatedUpdateHolder
public
getDefaultRSSLink()

No description

from  DatedUpdateHolder
public
getDefaultAtomLink()

No description

from  DatedUpdateHolder
public
getSubscriptionTitle()

No description

from  DatedUpdateHolder

Details

in DatedUpdateHolder at line 42
UpdateTags()

Find all distinct tags (TaxonomyTerms) associated with the DatedUpdatePages under this holder.

in DatedUpdateHolder at line 66
Updates($tagID = null, $dateFrom = null, $dateTo = null, $year = null, $monthNumber = null)

Wrapper to find all updates belonging to this holder, based on some filters.

Parameters

$tagID
$dateFrom
$dateTo
$year
$monthNumber

at line 44
static AllUpdates(string $className = NewsPage::class, int|null $parentID = null, int|null $tagID = null, string|null $dateFrom = null, string|null $dateTo = null, int|null $year = null, int|null $monthNumber = null)

Find all site's news items, based on some filters.

Omitting parameters will prevent relevant filters from being applied. The filters are ANDed together.

Parameters

string $className

The name of the class to fetch.
int|null $parentID

The ID of the holder to extract the updates from.
int|null $tagID

The ID of the tag to filter the updates by.
string|null $dateFrom

The beginning of a date filter range.
string|null $dateTo

The end of the date filter range. If empty, only one day will be searched for.
int|null $year

Numeric value of the year to show.
int|null $monthNumber

Numeric value of the month to show.

in DatedUpdateHolder at line 188
static ExtractMonths(DataList $updates, string $link = null, int $currentYear = null, int $currentMonthNumber = null)

Produce an ArrayList of available months out of the updates contained in the DataList.

Here is an example of the returned structure: ArrayList: ArrayData: YearName => 2013 Months => ArrayList: MonthName => Jan MonthNumber => 1 MonthLink => (page URL)year=2012&month=1 Active => true ArrayData: YearName => 2012 Months => ArrayList: ...

Parameters

DataList $updates

DataList DataList to extract months from.
string $link

Link used as abase to construct the MonthLink.
int $currentYear

Currently selected year, for computing the link active state.
int $currentMonthNumber

Currently selected month, for computing the link active state.

No description

No description

in DatedUpdateHolder at line 275
getSubscriptionTitle()

No description