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 EventConfig

Event Config

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

Returns

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

Returns

boolean
Entry cycle.
public string
# lifespan( )

Valid DateTime string

Valid DateTime string

Returns

string
Event expiry.
public string
# objType( )

Returns

string
Event 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
Event parent section slug.
public Charcoal\Cms\Config\EventConfig
# setNumPerPage( integer $numPerPage )

Parameters

$numPerPage
Number of event per page.

Returns

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

Parameters

$entryCycle
Cycle event or not.

Returns

Charcoal\Cms\Config\EventConfig
public Charcoal\Cms\Config\EventConfig
# setLifespan( string $lifespan )

Accept all DateTime string.

Accept all DateTime string.

Parameters

$lifespan
Event expiry.

Returns

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

Parameters

$objType
Event object type.

Returns

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

Parameters

$category
Event category object.

Returns

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

Might be overkill.

Might be overkill.

Parameters

$configFeatIdent
Config property containing featured event.

Returns

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

resize -> width.

resize -> width.

Parameters

$thumbnail
Event thumbnail size.

Returns

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

Parameters

$parentSectionSlug
Event parent section (slug).

Returns

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