Cecil

Create extends AbstractStep

Create taxonomies step.

This step is responsible for creating taxonomies based on the configuration. It initializes a collection of vocabularies for each language defined in the configuration and collects terms from the pages' front matter. The created vocabularies and terms are then set in the builder for further processing.

Table of Contents

Properties

$builder  : Builder
$canProcess  : bool
$config  : Config
$options  : Builder::OPTIONS
Configuration options for the step.
$vocabCollection  : array<string|int, mixed>

Methods

__construct()  : mixed
StepInterface constructor.
canProcess()  : bool
Method to know if the step can be processed.
getName()  : string
Returns the step name.
init()  : void
This method is called before the step is processed to initialize the step with necessary options and to determine if it can be executed.
process()  : void
Process implementation.
collectTermsFromPages()  : void
Collects vocabularies/terms from pages front matter.
createVocabulariesCollection()  : void
Creates a collection from the vocabularies configuration.
hasTaxonomies()  : bool
Checks if there is enabled taxonomies in config.

Properties

$options

Configuration options for the step.

protected Builder::OPTIONS $options

$vocabCollection

protected array<string|int, mixed> $vocabCollection

Methods

canProcess()

Method to know if the step can be processed.

public canProcess() : bool

If init() is used, true by default.

Return values
bool

getName()

Returns the step name.

public getName() : string
Return values
string

init()

This method is called before the step is processed to initialize the step with necessary options and to determine if it can be executed.

public init(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>

process()

Process implementation.

public process() : void

collectTermsFromPages()

Collects vocabularies/terms from pages front matter.

protected collectTermsFromPages() : void

createVocabulariesCollection()

Creates a collection from the vocabularies configuration.

protected createVocabulariesCollection() : void

hasTaxonomies()

Checks if there is enabled taxonomies in config.

private hasTaxonomies() : bool
Return values
bool
 
On this page

Search results