kai-jacobsen/kontentblocks

<?php

namespace Kontentblocks\Backend\EditScreens;

use Exception;
use Kontentblocks\Backend\Environment\PostEnvironment;
use Kontentblocks\Backend\EditScreens\Layouts\EditScreenLayout;
use Kontentblocks\Utils\_K;

/**
 * Class ScreenManager
 * @package Kontentblocks\Backend\Screen
 */
class ScreenManager
{

    /**
     * Collection of single context renderer
     * @var array
     */
    public $contextRenderer;

    /**
     * @var EditScreenLayout
     */
    public $selectedLayout;

    /**
     * Raw areas are all areas which are available in the current environment
     * e.g. are assigned to current page template and/or post type
     * @var array
     * @since 0.1.0
     */
    protected $areas;

    /**
     * Environment Instance
     * @var \Kontentblocks\Backend\Environment\PostEnvironment
     * @since 0.1.0
     */
    protected $environment;

    /**
     * Definition of possible sections for the edit screen
     * A context does not get rendered if there are no areas
     * assigned to it.
     * @var array
     * @since 0.1.0
     */
    protected $contextLayout;

    /**
     * Final sorted assignment of areas to contexts
     * @var array
     * @since 0.1.0
     */
    protected $contexts;

    /**
     * @var array
     */
    protected $screenLayouts;

    /**
     * Class Constructor
     *
     * @param $areas
     * @param PostEnvironment $environment
     *
     */
    public function __construct($areas, PostEnvironment $environment)
    {
        // setup raw areas
        $this->areas = $areas;
        // set this environment
        $this->environment = $environment;
        //setup region layout
        $this->contextLayout = $this->setupContextLayout();
        // setup filtered areas
        $this->contexts = $this->areasSortedByContext();
        // test if final context layout includes an sidebar
        // e.g. if an non-dynamic area is assigned to 'side'
        $this->selectedLayout = $this->setupLayout();

    }

    /**
     * @return array
     */
    private function setupContextLayout()
    {
        return apply_filters('kb.screen.context.layout', self::getDefaultContextLayout(), $this);
    }

    /**
     * Default Context Layout
     *
     * @return array default context layout
     * @since 0.1.0
     */
    public static function getDefaultContextLayout()
    {
        $defaults = array(
            'top' => array(
                'id' => 'top',
                'title' => __('Header', 'kontentblocks'),
                'description' => apply_filters('kb_context_description_top', '')
            ),
            'normal' => array(
                'id' => 'normal',
                'title' => __('Content', 'kontentblocks'),
                'description' => apply_filters('kb_context_description_content', '')
            ),
            'side' => array(
                'id' => 'side',
                'title' => __('Sidebar', 'kontentblocks'),
                'description' => apply_filters('kb_context_description_side', '')
            ),
            'side2' => array(
                'id' => 'side2',
                'title' => __('Sidebar 2', 'kontentblocks'),
                'description' => apply_filters('kb_context_description_side2', '')
            ),
            'bottom' => array(
                'id' => 'bottom',
                'title' => __('Footer', 'kontentblocks'),
                'description' => apply_filters('kb_context_description_bottom', '')
            )
        );

        // plugins may change this
        $filtered = apply_filters('kb.default.context.layout', $defaults);
        // old filter for bc
        return apply_filters('kb_default_context_layout', $filtered);

    }

    /**
     * Sort raw Area definitions to array
     * @throws Exception
     * @return array
     * @since 0.1.0
     */
    public function areasSortedByContext()
    {
        $areas = array();
        $contextsOrder = $this->environment->getDataProvider()->get('_kbcontexts');

        if (!$this->areas) {
            return array();
        }

        // @TODO 157 159 was commented out, and that was probably correct
        foreach ($this->areas as $area) {
//            if (!$area->dynamic || ($area->dynamic && $area->settings->isAttached())) {
            $areas[$area->context][$area->id] = $area;
//            }
        }

        if (is_array($contextsOrder) && !empty($contextsOrder)) {
            foreach ($contextsOrder as $context => $areaIds) {
                if (is_array($areaIds)) {
                    foreach (array_reverse(array_keys($areaIds)) as $areaId) {
                        if (isset($areas[$context][$areaId])) {
                            $tmp = $areas[$context][$areaId];
                            unset($areas[$context][$areaId]);
                            $areas[$context] = array($areaId => $tmp) + $areas[$context];
                        }
                    }
                }
            }
        }

        return $areas;
    }

    /**
     * @return EditScreenLayout
     */
    private function setupLayout()
    {
        $screenLayouts = \Kontentblocks\EditScreenLayoutsRegistry()->layouts;
        $lyt = apply_filters('kb.screenLayout', 'default-boxes', $this->environment, $screenLayouts);
        _K::info("Screenlayout found: {$lyt}");
        $selectedLayout = (isset($screenLayouts[$lyt])) ? $screenLayouts[$lyt] : $screenLayouts['default-boxes'];
        \Kontentblocks\JSONTransport()->registerPublicData('config', 'layoutMode', $lyt);
        return $selectedLayout;
    }

    /**
     * Instantiate a context object for each context and render
     * @since 0.1.0
     */
    public function render()
    {
        _K::info("ScreenManager will render");
        foreach ($this->contextLayout as $args) {
            // delegate the actual output to ScreenContext
            $this->contextRenderer[$args['id']] = new ScreenContext(
                $args,
                $this->getContextAreas($args['id']),
                $this->environment
            );
        }

        $this->selectedLayout->addData(array(
            'contexts' => $this->contextRenderer
        ));

        $this->selectedLayout->render(true);
        _K::info("ScreenManager did render");

    }

    /**
     * Getter to retrieve areas by context id
     *
     * @param $contextId
     *
     * @return array
     * @since 0.1.0
     */
    public function getContextAreas($contextId)
    {
        if (isset($this->contexts[$contextId])) {
            return $this->contexts[$contextId];
        } else {
            return array();
        }

    }


    /**
     * Getter for all areas
     * @return array
     * @since 0.1.0
     */
    public function getAreas()
    {
        return $this->areas;

    }

    /**
     * Getter for Environment instance
     * @return PostEnvironment
     * @since 0.1.0
     */
    public function getEnvironment()
    {
        return $this->environment;
    }

}