kai-jacobsen/kontentblocks

<?php

namespace Kontentblocks\Backend\Environment;

use JsonSerializable;
use Kontentblocks\Areas\AreaSettingsModel;
use Kontentblocks\Backend\DataProvider\DataProvider;
use Kontentblocks\Backend\DataProvider\DataProviderService;
use Kontentblocks\Backend\Storage\ModuleStorage;
use Kontentblocks\Backend\Environment\Save\SavePost;
use Kontentblocks\Kontentblocks;
use Kontentblocks\Modules\ModuleRepository;
use Kontentblocks\Panels\PostPanel;
use Kontentblocks\Panels\PostPanelRepository;


/**
 * KDPost Environment
 *
 * @package Kontentblocks
 * @subpackage KDPost
 * @since 0.1.0
 */
class PostEnvironment implements JsonSerializable, EnvironmentInterface
{

    /**
     * generic low-level data handler
     * @var DataProvider
     */
    protected $dataProvider;

    /**
     * Module specific storage handler
     * @var \Kontentblocks\Backend\Storage\ModuleStorage
     */
    protected $storage;

    /**
     * Access object to all env related modules
     * @var ModuleRepository
     */
    protected $moduleRepository;


    /**
     * Access object to all env related panels
     * @var PostPanelRepository
     */
    protected $panelRepository;


    /**
     * @var int
     */
    protected $storageId;

    /**
     * @var \WP_Post
     */
    protected $postObj;

    /**
     * @var string
     */
    protected $pageTemplate;

    /**
     * @var string
     */
    protected $postType;

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

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

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

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

    /**
     * @var int
     */
    protected $blogId;


    /**
     * Class constructor
     *
     * @param int $storageId
     * @param \WP_Post $postObj
     * @since 0.1.0
     */
    public function __construct($storageId, \WP_Post $postObj)
    {
        $this->postObj = $postObj;
        $this->storageId = $storageId;
        $this->storage = new ModuleStorage($storageId);
        $this->pageTemplate = $this->getPageTemplate();
        $this->postType = $this->getPostType();
        $this->areas = $this->setupAreas();
        $this->areasToContext();
        $this->panelRepository = new PostPanelRepository($this);
        $this->panels = $this->panelRepository->getPanelObjects();
        $this->blogId = get_current_blog_id();
    }

    /**
     * returns the page template if available
     * returns 'default' if not. in order to normalize the object property
     * If post type does not support page templates, it's still
     * 'default' on the module
     * @return string
     * @since 0.1.0
     */
    public function getPageTemplate()
    {
        // value is handled by wordpress, so stick to post meta api
        $tpl = get_post_meta($this->storageId, '_wp_page_template', true);

        if ($tpl !== '') {
            return $tpl;
        }

        return 'default';

    }

    /**
     * Get Post Type
     * @since 0.1.0
     */
    public function getPostType()
    {
        if (!$this->postType) {
            $postObj = $this->getPostObject();
            if (wp_is_post_revision($postObj)) {
                $this->postType = get_post_type($postObj->post_parent);
            } else {
                $this->postType = get_post_type($this->storageId);
            }
        }
        return $this->postType;
    }

    /**
     * @return \WP_Post
     * @since 0.1.0
     */
    public function getPostObject()
    {
        return $this->postObj;
    }

    /**
     * Augment areas with Settings instance
     * Settings are environment related so this must happen late
     * @since 0.3.0
     */
    private function setupAreas()
    {
        $areas = $this->findAreas();

        /** @var \Kontentblocks\Areas\AreaProperties $area */
        foreach ($areas as $area) {
            $area->set('settings', new AreaSettingsModel($area,
                DataProviderService::getPostProvider($this->postObj->ID)));
        }
        return $areas;

    }

    /**
     * returns all areas which are available in this environment
     * @return array
     * @since 0.1.0
     */
    public function findAreas()
    {

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

        /** @var \Kontentblocks\Areas\AreaRegistry $areaRegistry */
        $areaRegistry = Kontentblocks::getService('registry.areas');
        return $areaRegistry->filterForPost($this);
    }

    /**
     * @since 0.3.0
     */
    private function areasToContext()
    {
        if (is_array($this->areas) && !empty($this->areas)) {
            foreach ($this->areas as $id => $area) {
                $this->areasByContext[$area->context][$id] = $area;
            }
        }
    }

    public function initUi()
    {
        $panels = $this->getPanels();
        foreach ($panels as $panel) {
            $panel->init();
        }
    }

    /**
     * @return array
     */
    public function getPanels()
    {
        return $this->panels;
    }

    /**
     * returns the DataProvider instance
     * @return DataProvider
     * @since 0.1.0
     */
    public function getDataProvider()
    {
        return $this->storage->getDataProvider();
    }

    /**
     * @param $panelId
     * @return PostPanel|null
     */
    public function getPanelObject($panelId)
    {
        if (isset($this->panels[$panelId])) {
            return $this->panels[$panelId];
        }
        return null;
    }

    /**
     * Return ID for the current storage entity
     * (most likely equals post id)
     * @return int
     * @since 0.1.0
     */
    public function getId()
    {
        return absint($this->storageId);
    }

    /**
     * @return ModuleRepository
     */
    public function getModuleRepository()
    {
        if (is_null($this->moduleRepository)) {
            $this->moduleRepository = new ModuleRepository($this);
        }
        return $this->moduleRepository;
    }

    /**
     * Get Area Definition
     *
     * @param string $area
     * @return mixed
     * @since 0.1.0
     */
    public function getAreaDefinition($area)
    {
        if (isset($this->areas[$area])) {
            return $this->areas[$area];
        } else {
            return false;
        }

    }

    /**
     * Get all post-specific areas
     * @return array
     * @since 0.1.0
     */
    public function getAreas()
    {
        return $this->areas;
    }

    /**
     *
     * @param $context
     * @return array
     * @since 0.3.0
     */
    public function getAreasForContext($context)
    {
        if (isset($this->areasByContext[$context]) && is_array($this->areasByContext[$context])) {
            return $this->areasByContext[$context];
        }

        return array();
    }

    /**
     * Save callback handler
     * @return void
     * @since 0.1.0
     */
    public function save($postId, $postObj)
    {
        $saveHandler = new SavePost($this);
        $saveHandler->save($postId, $postObj);

    }

    /**
     * Return this Storage Object
     * @return ModuleStorage
     * @since 0.1.0
     */
    public function getStorage()
    {
        return $this->storage;
    }

    /**
     */
    public function toJSON()
    {
        echo "<script> var KB = KB || {}; KB.Environment =" . json_encode($this) . "</script>";
    }

    /**
     * @return mixed
     */
    public function export()
    {
        return $this->jsonSerialize();
    }

    /**
     * (PHP 5 &gt;= 5.4.0)<br/>
     * Specify data which should be serialized to JSON
     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
     * @return mixed data which can be serialized by <b>json_encode</b>,
     * which is a value of any type other than a resource.
     * @since 0.1.0
     */
    function jsonSerialize()
    {
        return array(
            'postId' => absint($this->storageId),
            'pageTemplate' => $this->getPageTemplate(),
            'postType' => $this->getPostType(),
            'entityType' => 'post'
        );
    }
}