Overview

Namespaces

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

Classes

  • AbstractManager
  • EventManager
  • NewsManager
  • Overview
  • Namespace
  • Class

Class NewsManager

News manager

Charcoal\Cms\Service\Manager\AbstractManager uses Charcoal\Translator\TranslatorAwareTrait (not available)
Extended by Charcoal\Cms\Service\Manager\NewsManager uses Charcoal\Object\CategoryTrait (not available)
Namespace: Charcoal\Cms\Service\Manager
Located at Charcoal/Cms/Service/Manager/NewsManager.php
Methods summary
public
# __construct( array $data )

NewsManager constructor.

NewsManager constructor.

Parameters

$data
The Data.

Throws

Exception
When $data index is not set.

Overrides

Charcoal\Cms\Service\Manager\AbstractManager::__construct()
public mixed
# entries( )

To be displayed news list.

To be displayed news list.

Returns

mixed
The news collection.
public Charcoal\Loader\CollectionLoader
# entriesLoader( )

Returns

Charcoal\Loader\CollectionLoader
public mixed
# entry( integer|null $id = null )

Parameters

$id
The news id.

Returns

mixed
public Charcoal\Cms\NewsInterface[]|Charcoal\Model\Collection
# all( )

All available news.

All available news.

Returns

Charcoal\Cms\NewsInterface[]|Charcoal\Model\Collection
The news collection.
public Charcoal\Object\CategoryInterface|Charcoal\Model\Collection
# loadCategoryItems( )

Returns

Charcoal\Object\CategoryInterface|Charcoal\Model\Collection
The category collection.
public Charcoal\Object\CategoryInterface
# categoryItem( integer $id )

Parameters

$id
The category id.

Returns

Charcoal\Object\CategoryInterface
public mixed
# featList( array $options = [] )

Parameters

$options
The options for the collection loader.

Returns

mixed

Throws

Exception
When featured news ident is not valid.
public Charcoal\Cms\NewsInterface[]|Charcoal\Model\Collection
# archive( )

Returns

Charcoal\Cms\NewsInterface[]|Charcoal\Model\Collection
public Charcoal\Cms\NewsInterface|array
# latest( )

Get the latest news.

Get the latest news.

Returns

Charcoal\Cms\NewsInterface|array
The latest news.
public mixed
# prev( )

Returns

mixed
The previous news
public mixed
# next( )

Returns

mixed
The next news
public float|integer
# currentPage( )

Returns

float|integer
The current news index page ident.
public mixed
# currentNews( )

Returns

mixed
public integer
# numPerPage( )

Returns

integer
public boolean
# entryCycle( )

Returns

boolean
public integer
# numNews( )

Amount of news (total)

Amount of news (total)

Returns

integer
How many news?
public float
# numPages( )

The total amount of pages.

The total amount of pages.

Returns

float
public boolean
# hasPager( )

Is there a pager.

Is there a pager.

Returns

boolean
public integer
# page( )

Returns

integer
public integer
# category( )

Returns

integer
public mixed
# objType( )

Returns

mixed
public mixed
# featIdent( )

Returns

mixed
public Charcoal\Cms\Service\Loader\NewsLoader
# loader( )

Returns

Charcoal\Cms\Service\Loader\NewsLoader
public Charcoal\Cms\Service\Manager\NewsManager
# setCurrentNews( mixed $currentNews )

Parameters

$currentNews
The current news context.

Returns

Charcoal\Cms\Service\Manager\NewsManager
.
public Charcoal\Cms\Service\Manager\NewsManager
# setNumPerPage( integer $numPerPage )

Parameters

$numPerPage
The number of news per page.

Returns

Charcoal\Cms\Service\Manager\NewsManager
public Charcoal\Cms\Service\Manager\NewsManager
# setEntryCycle( boolean $entryCycle )

Parameters

$entryCycle
Next and Prev cycles indefinitely.

Returns

Charcoal\Cms\Service\Manager\NewsManager
public Charcoal\Cms\Service\Manager\NewsManager
# setPage( integer $page )

Parameters

$page
The page number to load.

Returns

Charcoal\Cms\Service\Manager\NewsManager
public Charcoal\Cms\Service\Manager\NewsManager
# setCategory( integer $category )

Parameters

$category
The current news category.

Returns

Charcoal\Cms\Service\Manager\NewsManager
public Charcoal\Cms\Service\Manager\NewsManager
# setObjType( mixed $objType )

Parameters

$objType
The object type.

Returns

Charcoal\Cms\Service\Manager\NewsManager
public Charcoal\Cms\Service\Manager\NewsManager
# setFeatIdent( mixed $featIdent )

Parameters

$featIdent
The featured list ident.

Returns

Charcoal\Cms\Service\Manager\NewsManager
public Charcoal\Cms\Service\Manager\NewsManager
# setLoader( Charcoal\Cms\Service\Loader\NewsLoader $loader )

Parameters

$loader
The news loader provider.

Returns

Charcoal\Cms\Service\Manager\NewsManager
public
# setPrevNext( )

Set the Prev and Next news

Set the Prev and Next news

Returns


$this
Methods inherited from Charcoal\Cms\Service\Manager\AbstractManager
adminConfig(), collectionLoader(), modelFactory(), setAdminConfig(), setCollectionLoader(), setModelFactory()
Properties summary
protected Charcoal\Cms\NewsInterface $currentNews

$currentNews The current news.

$currentNews The current news.

#
protected integer $currentPage

$currentPage The current Page.

$currentPage The current Page.

#
protected integer $numPerPage

$numPerPage News by page.

$numPerPage News by page.

# 0
protected integer $numPages

$numPages How many pages.

$numPages How many pages.

#
protected boolean $entryCycle

$pageCycle Does the pager can cycle indefinitely.

$pageCycle Does the pager can cycle indefinitely.

# false
protected Charcoal\Cms\NewsInterface $nextNews

$nextNews

$nextNews

#
protected Charcoal\Cms\NewsInterface $prevNews

$prevNews

$prevNews

#
protected integer $page

$page

$page

# 0
protected integer $category

$category

$category

# 0
protected Charcoal\Cms\NewsInterface[] $all

$all All the news.

$all All the news.

# []
protected Charcoal\Cms\NewsInterface[] $entries

$entries The news collection.

$entries The news collection.

# []
protected Charcoal\Cms\NewsInterface[] $archive

$archive The archive news collection.

$archive The archive news collection.

# []
protected Charcoal\Cms\NewsInterface $entry

$entry A news.

$entry A news.

#
protected object $objType

$objType The news object model.

$objType The news object model.

#
protected string $featIdent

$featIdent The config ident for featured news.

$featIdent The config ident for featured news.

#
protected Charcoal\Cms\NewsInterface[] $featList

$featList The config ident for featured news.

$featList The config ident for featured news.

# []
protected Charcoal\Cms\Service\Loader\NewsLoader $loader

$loader The news loader provider.

$loader The news loader provider.

#
protected array $categoryItem
# []
Properties inherited from Charcoal\Cms\Service\Manager\AbstractManager
$adminConfig, $collectionLoader, $modelFactory
API documentation generated by ApiGen