Overview

Namespaces

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

Classes

  • AbstractLoader
  • EventLoader
  • NewsLoader
  • SectionLoader
  • Overview
  • Namespace
  • Class

Class SectionLoader

Section Loader

Charcoal\Cms\Service\Loader\AbstractLoader uses Charcoal\Translator\TranslatorAwareTrait (not available)
Extended by Charcoal\Cms\Service\Loader\SectionLoader
Namespace: Charcoal\Cms\Service\Loader
Located at Charcoal/Cms/Service/Loader/SectionLoader.php
Methods summary
public mixed
# fromId( integer $id )

Parameters

$id
The section's id.

Returns

mixed
public mixed
# fromSlug( string $slug )

Parameters

$slug
The section's slug.

Returns

mixed
public Charcoal\Loader\CollectionLoader
# all( )

Returns

Charcoal\Loader\CollectionLoader
public ArrayAccess|Traversable
# masters( )

Returns

ArrayAccess|Traversable
public ArrayAccess|Traversable
# children( )

Returns

ArrayAccess|Traversable
public array
# sectionRoutes( )

Pair routes slug to sections ID

Pair routes slug to sections ID

Returns

array
public string
# resolveRoute( string $route )

Resolve latest route from route slug.

Resolve latest route from route slug.

Parameters

$route
The route to resolve.

Returns

string
public integer
# resolveSectionId( string $route )

Resolve section ID from route slug.

Resolve section ID from route slug.

Parameters

$route
The route to resolve.

Returns

integer
public object
# objType( )

Returns

object
public integer
# baseSection( )

Returns

integer
public array
# sectionTypes( )

Returns

array
public Charcoal\Cms\Service\Loader\SectionLoader
# setObjType( object $objType )

Parameters

$objType
The object type.

Returns

Charcoal\Cms\Service\Loader\SectionLoader
public Charcoal\Cms\Service\Loader\SectionLoader
# setBaseSection( integer $baseSection )

Parameters

$baseSection
The base section id.

Returns

Charcoal\Cms\Service\Loader\SectionLoader
public Charcoal\Cms\Service\Loader\SectionLoader
# setSectionTypes( array $sectionTypes )

Parameters

$sectionTypes
Section types array | null.

Returns

Charcoal\Cms\Service\Loader\SectionLoader
public static string
# snake( string $value, string $delimiter = '-' )

Convert a string to snake case.

Convert a string to snake case.

Parameters

$value
The value to convert.
$delimiter
The word delimiter.

Returns

string
Methods inherited from Charcoal\Cms\Service\Loader\AbstractLoader
__construct(), collectionLoader(), modelFactory(), setCollectionLoader(), setModelFactory()
Properties summary
protected array $sectionRoutes

$sectionRoutes The section's routes.

$sectionRoutes The section's routes.

#
protected integer $baseSection

$baseSection The id of the base section.

$baseSection The id of the base section.

#
protected static array $snakeCache

The cache of snake-cased words.

The cache of snake-cased words.

# []
Properties inherited from Charcoal\Cms\Service\Loader\AbstractLoader
$collectionLoader, $modelFactory, $objType
API documentation generated by ApiGen