Batflat/inc/core/BaseModule.php

<?php
/**
* This file is part of Batflat ~ the lightweight, fast and easy CMS
*
* @author       Paweł Klockiewicz <klockiewicz@sruu.pl>
* @author       Wojciech Król <krol@sruu.pl>
* @copyright    2017 Paweł Klockiewicz, Wojciech Król <Sruu.pl>
* @license      https://batflat.org/license
* @link         https://batflat.org
*/

namespace Inc\Core;

/**
 * Base class for each module functionality
 */
class BaseModule
{
    /**
     * Reference to Core instance
     *
     * @var \Inc\Core\Main
     */
    protected $core;

    /**
     * Reference to Template instance
     *
     * @var \Inc\Core\Lib\Templates
     */
    protected $tpl;

    /**
     * Reference to Router instance
     *
     * @var \Inc\Core\Lib\Router
     */
    protected $route;

    /**
     * Reference to Settings instance
     *
     * @var \Inc\Core\Lib\Settings
     */
    protected $settings;

    /**
     * Module dir name
     *
     * @var string
     */
    protected $name;

    /**
     * Reference to language array
     *
     * @var array
     */
    protected $lang;

    /**
     * Module constructor
     *
     * @param Inc\Core\Main $core
     * @return void
     */
    public function __construct(Main $core)
    {
        $this->core = $core;
        $this->tpl = $core->tpl;
        $this->router = $core->router;
        $this->settings = $core->settings;
        $this->lang = $core->lang;
        $this->name = strtolower(str_replace(['Inc\Modules\\', '\\Admin', '\\Site'], null, static::class));
    }

    /**
     * Module initialization
     *
     * @return void
     */
    public function init()
    {
    }

    /**
     * Procedures before destroy
     *
     * @return void
     */
    public function finish()
    {
    }

    /**
    * Languages list
    * @param string $selected
    * @param string $active ('active' or 'selected')
    * @return array
    */
    protected function _getLanguages($selected = null, $active = 'active')
    {
        $langs = glob(BASE_DIR.'/inc/lang/*', GLOB_ONLYDIR);
        
        $result = [];
        foreach ($langs as $lang) {
            if ($selected == basename($lang)) {
                $attr = $active;
            } else {
                $attr = null;
            }
            $result[] = ['name' => basename($lang), 'attr' => $attr];
        }
        return $result;
    }

    /**
     * Hook to draw template with set variables
     *
     * @param string $file
     * @param array $variables
     * @return string
     */
    protected function draw($file, array $variables = [])
    {
        if (!empty($variables)) {
            foreach ($variables as $key => $value) {
                $this->tpl->set($key, $value);
            }
        }

        if (strpos($file, BASE_DIR) !== 0) {
            if ($this instanceof AdminModule) {
                $file = MODULES.'/'.$this->name.'/view/admin/'.$file;
            } else {
                $file = MODULES.'/'.$this->name.'/view/'.$file;
            }
        }

        return $this->tpl->draw($file);
    }

    /**
     * Get current module language value
     *
     * @param string $key
     * @param string $module
     * @return string
     */
    protected function lang($key, $module = null)
    {
        if (empty($module)) {
            $module = $this->name;
        }

        return isset_or($this->lang[$module][$key], null);
    }

    /**
     * Get or set module settings
     *
     * @param string $module Example 'module' or shorter 'module.field'
     * @param mixed $field If module has field it contains value
     * @param mixed $value OPTIONAL
     * @return mixed
     */
    protected function settings($module, $field = false, $value = false)
    {
        if (substr_count($module, '.') == 1) {
            $value = $field;
            list($module, $field) = explode('.', $module);
        }

        if ($value === false) {
            return $this->settings->get($module, $field);
        } else {
            return $this->settings->set($module, $field, $value);
        }
    }

    /**
     * Database QueryBuilder
     *
     * @param string $table
     * @return \Inc\Core\Lib\QueryBuilder
     */
    protected function db($table = null)
    {
        return $this->core->db($table);
    }

    /**
    * Create notification
    * @param string $type ('success' or 'failure')
    * @param string $text
    * @param mixed $args [, mixed $... ]]
    * @return void
    */
    protected function notify()
    {
        call_user_func_array([$this->core, 'setNotify'], func_get_args());
    }
}