API Documentation
\
Charcoal
Admin
Widget
Cms
Cms
Config
Mixin
Traits
Route
Section
Service
Loader
Manager
ServiceProvider
Support
Helpers
Interfaces
Traits
Property

\Charcoal\Cms\ConfigNewsConfig

News Config

Summary

Methods
Properties
Constants
numPerPage()
entryCycle()
defaultExpiry()
median()
objType()
category()
configFeatIdent()
thumbnail()
parentSectionSlug()
setNumPerPage()
setEntryCycle()
setDefaultExpiry()
setMedian()
setObjType()
setCategory()
setConfigFeatIdent()
setThumbnail()
setParentSectionSlug()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$numPerPage
$entryCycle
$defaultExpiry
$median
$objType
$category
$configFeatIdent
$thumbnail
$parentSectionSlug
N/A

Properties

$numPerPage

$numPerPage : integer

Type

integer

$entryCycle

$entryCycle : string

Type

string

$defaultExpiry

$defaultExpiry : string

Type

string

$median

$median : string

Type

string

$objType

$objType : string

Type

string

$category

$category : string

Type

string

$configFeatIdent

$configFeatIdent : string

Type

string

$thumbnail

$thumbnail : array

Type

array

$parentSectionSlug

$parentSectionSlug : string

l10n

Type

string

Methods

numPerPage()

numPerPage() : integer

Returns

integer —

Number of items per page.

entryCycle()

entryCycle() : boolean

Returns

boolean —

Entry cycle.

defaultExpiry()

defaultExpiry() : string

Valid DateTime string

Returns

string —

News expiry.

median()

median() : string

Returns

string —

Datetime value.

objType()

objType() : string

Returns

string —

News Object type.

category()

category() : string

Returns

string —

Category object.

configFeatIdent()

configFeatIdent() : string

Returns

string —

Config property.

thumbnail()

thumbnail() : array

Returns

array —

Thumbnail generation values.

parentSectionSlug()

parentSectionSlug() : string

Returns

string —

News parent section slug.

setNumPerPage()

setNumPerPage(integer  $numPerPage) : \Charcoal\Cms\Config\NewsConfig

Parameters

integer $numPerPage

Number of news per page.

Returns

\Charcoal\Cms\Config\NewsConfig

setEntryCycle()

setEntryCycle(boolean  $entryCycle) : \Charcoal\Cms\Config\NewsConfig

Parameters

boolean $entryCycle

Cycle news or not.

Returns

\Charcoal\Cms\Config\NewsConfig

setDefaultExpiry()

setDefaultExpiry(string  $defaultExpiry) : \Charcoal\Cms\Config\NewsConfig

Accept all DateTime string.

Parameters

string $defaultExpiry

Expiry.

Returns

\Charcoal\Cms\Config\NewsConfig

setMedian()

setMedian(string  $median) : \Charcoal\Cms\Config\NewsConfig

Parameters

string $median

DateTime string.

Returns

\Charcoal\Cms\Config\NewsConfig

setObjType()

setObjType(string  $objType) : \Charcoal\Cms\Config\NewsConfig

Parameters

string $objType

News object type.

Returns

\Charcoal\Cms\Config\NewsConfig

setCategory()

setCategory(string  $category) : \Charcoal\Cms\Config\NewsConfig

Parameters

string $category

News category object.

Returns

\Charcoal\Cms\Config\NewsConfig

setConfigFeatIdent()

setConfigFeatIdent(string  $configFeatIdent) : \Charcoal\Cms\Config\NewsConfig

Might be overkill.

Parameters

string $configFeatIdent

Config property containing featured news.

Returns

\Charcoal\Cms\Config\NewsConfig

setThumbnail()

setThumbnail(array  $thumbnail) : \Charcoal\Cms\Config\NewsConfig

resize -> width.

Parameters

array $thumbnail

News thumbnail size.

Returns

\Charcoal\Cms\Config\NewsConfig

setParentSectionSlug()

setParentSectionSlug(string  $parentSectionSlug) : \Charcoal\Cms\Config\NewsConfig

Parameters

string $parentSectionSlug

News parent section (slug).

Returns

\Charcoal\Cms\Config\NewsConfig