Overview

Namespaces

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

Classes

  • CmsConfig
  • EventConfig
  • NewsConfig
  • SectionConfig
  • Overview
  • Namespace
  • Class

Class NewsConfig

News Config

Charcoal\Config\AbstractConfig
Extended by Charcoal\Cms\Config\NewsConfig
Namespace: Charcoal\Cms\Config
Located at Charcoal/Cms/Config/NewsConfig.php
Methods summary
public integer
# numPerPage( )

Returns

integer
Number of items per page.
public boolean
# entryCycle( )

Returns

boolean
Entry cycle.
public string
# defaultExpiry( )

Valid DateTime string

Valid DateTime string

Returns

string
News expiry.
public string
# median( )

Returns

string
Datetime value.
public string
# objType( )

Returns

string
News Object type.
public string
# category( )

Returns

string
Category object.
public string
# configFeatIdent( )

Returns

string
Config property.
public array
# thumbnail( )

Returns

array
Thumbnail generation values.
public string
# parentSectionSlug( )

Returns

string
News parent section slug.
public Charcoal\Cms\Config\NewsConfig
# setNumPerPage( integer $numPerPage )

Parameters

$numPerPage
Number of news per page.

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\NewsConfig
# setEntryCycle( boolean $entryCycle )

Parameters

$entryCycle
Cycle news or not.

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\NewsConfig
# setDefaultExpiry( string $defaultExpiry )

Accept all DateTime string.

Accept all DateTime string.

Parameters

$defaultExpiry
Expiry.

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\NewsConfig
# setMedian( string $median )

Parameters

$median
DateTime string.

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\NewsConfig
# setObjType( string $objType )

Parameters

$objType
News object type.

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\NewsConfig
# setCategory( string $category )

Parameters

$category
News category object.

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\NewsConfig
# setConfigFeatIdent( string $configFeatIdent )

Might be overkill.

Might be overkill.

Parameters

$configFeatIdent
Config property containing featured news.

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\NewsConfig
# setThumbnail( array $thumbnail )

resize -> width.

resize -> width.

Parameters

$thumbnail
News thumbnail size.

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\NewsConfig
# setParentSectionSlug( string $parentSectionSlug )

Parameters

$parentSectionSlug
News parent section (slug).

Returns

Charcoal\Cms\Config\NewsConfig
API documentation generated by ApiGen