What's on this page

• Pages Generator
• Templates extension
• Output post processor

Extend

There is several way to extend Cecil:

1. Pages Generator
2. Template extension
3. Output post processor

Pages Generator

A Generator help you to create pages without Markdown files (with data from a database or an API) or alter existing pages.

Just add your Generator to the pages.generators list, and create a new class in the Cecil\Generator namespace.

Example:

/generators/Cecil/Generator/DummyPage.php

<?php
namespace Cecil\Generator;

use Cecil\Collection\Page\Page;
use Cecil\Collection\Page\Type;

class DummyPage extends AbstractGenerator implements GeneratorInterface
{
    public function generate(): void
    {
        // create a new page $page, then add it to the site collection
        $page = (new Page('my-page'))
            ->setType(Type::PAGE->value)
            ->setPath('mypage')
            ->setBodyHtml('<p>My page body</p>')
            ->setVariable('language', 'en')
            ->setVariable('title', 'My page')
            ->setVariable('date', now())
            ->setVariable('menu', ['main' => ['weight' => 99]]);
        $this->generatedPages->add($page);
    }
}

/generators/Cecil/Generator/Database.php

<?php
namespace Cecil\Generator;

use Cecil\Collection\Page\Page;
use Cecil\Collection\Page\Type;

class Database extends AbstractGenerator implements GeneratorInterface
{
    public function generate(): void
    {
        $db = new SQLite3('database.sqlite');
        $statement = $db->prepare('SELECT ...');
        $result = $statement->execute();
        while ($row = $result->fetchArray(SQLITE3_ASSOC)) {
            $page = (new Page($row['page-id']))
              ->setType(Type::PAGE->value)
              ->setPath($row['path'])
              ->setBodyHtml($row['html'])
              ->setVariable('title', $row['title'])
              ->setVariable('date', $row['date'])
            $this->generatedPages->add($page);
        }
        $result->finalize();
        $db->close();
    }
}

configuration

pages:
  generators:
    35: Cecil\Generator\Database
    99: Cecil\Generator\DummyPage

Templates extension

You can add custom functions and filters:

1. create a Twig extension in the Cecil\Renderer\Extension namespace
2. add the PHP file in the extensions directory
3. add the class name to the configuration

Example:

/extensions/Cecil/Renderer/Extension/MyExtension.php

<?php
namespace Cecil\Renderer\Extension;

class MyExtension extends \Twig\Extension\AbstractExtension
{
    public function getFilters()
    {
        return [
            new \Twig\TwigFilter('md5', 'md5'),
        ];
    }
}

configuration

layouts:
  extensions:
    MyExtension: Cecil\Renderer\Extension\MyExtension

Output post processor

You can post process page output.

Just add your post processor to the output.postprocessors list, and create a new class in the Cecil\Renderer\PostProcessor namespace.

Example:

/postprocessors/Cecil/Renderer/PostProcessor/MyProcessor.php

<?php
namespace Cecil\Renderer\PostProcessor;

use Cecil\Collection\Page\Page;

class MyProcessor extends AbstractPostProcessor
{
    public function process(Page $page, string $output, string $format): string
    {
        // handle $output here

        return $output;
    }
}

configuration

output:
  postprocessors:
    - Cecil\Renderer\PostProcessor\MyProcessor

Suggest a modification