CrudDefinitionBuilder.php

<?php

/**
 * PepisCMS
 *
 * Simple content management system
 *
 * @package             PepisCMS
 * @author              Piotr Polak
 * @copyright           Copyright (c) 2007-2018, Piotr Polak
 * @license             See license.txt
 * @link                http://www.polak.ro/
 */

defined('BASEPATH') or exit('No direct script access allowed');

/**
 * Class CrudDefinitionBuilder
 *
 * @since 1.0.0
 */
class CrudDefinitionBuilder
{
    private $newlineCounter = 1;

    /**
     * @var CrudFieldDefinitionBuilder[]
     */
    private $fieldBuilders = array();

    /**
     * @var string
     */
    private $moduleName;

    /**
     * @var PEPISCMS_Lang
     */
    private $lang;

    /**
     * @var bool
     */
    private $isWithImplicitTranslations = false;

    /**
     * Private constructor.
     */
    private function __construct()
    {
    }

    public static function create()
    {
        return new CrudDefinitionBuilder();
    }

    /**
     * @param $fieldName
     * @return CrudFieldDefinitionBuilder
     * @throws Exception
     */
    public function withField($fieldName)
    {
        if (!$fieldName) {
            throw new \Exception('Field name must be specified.');
        }
        $fieldBuilder = new CrudFieldDefinitionBuilder($fieldName, $this);
        $this->fieldBuilders[$fieldName] = $fieldBuilder;
        return $fieldBuilder;
    }

    /**
     * @return CrudDefinitionBuilder
     */
    public function withLineBreak()
    {
        $fieldName = 'newline' . $this->newlineCounter;

        $this->newlineCounter++;

        $fieldBuilder = new CrudFieldDefinitionBuilder($fieldName, $this);
        $fieldBuilder->withValidationRules('')
            ->withShowInGrid(false)
            ->withInputType(FormBuilder::LINE_BREAK);
        $this->fieldBuilders[$fieldName] = $fieldBuilder;
        return $fieldBuilder->end();
    }

    /**
     * Enables implicit translations
     *
     * @param $moduleName string
     * @param $lang PEPISCMS_Lang
     * @return $this
     */
    public function withImplicitTranslations($moduleName, $lang)
    {
        $this->moduleName = $moduleName;
        $this->lang = $lang;
        $this->isWithImplicitTranslations = true;
        return $this;
    }

    /**
     * @return array
     */
    public function build()
    {
        $output = array();
        foreach ($this->fieldBuilders as $fieldName => $fieldBuilder) {
            if ($this->isWithImplicitTranslations) {
                $fieldBuilder->withImplicitTranslations($this->moduleName, $this->lang);
            }
            $output[$fieldName] = $fieldBuilder->build();
        }

        return $output;
    }
}