phpOMS/Module/ModuleAbstract.php

<?php
/**
 * Orange Management
 *
 * PHP Version 7.2
 *
 * @package    phpOMS\Module
 * @copyright  Dennis Eichhorn
 * @license    OMS License 1.0
 * @version    1.0.0
 * @link       http://website.orange-management.de
 */
declare(strict_types=1);

namespace phpOMS\Module;

use phpOMS\Message\RequestAbstract;
use phpOMS\Message\ResponseAbstract;
use phpOMS\System\MimeType;

/**
 * Module abstraction class.
 *
 * @package    phpOMS\Module
 * @license    OMS License 1.0
 * @link       http://website.orange-management.de
 * @since      1.0.0
 *
 * @todo: maybe move to Modules because this is very project specific and not general enough for a framework
 * @todo: maybe move all of the Module\classes parts to the Modules\?
 */
abstract class ModuleAbstract
{

    /**
     * Module name.
     *
     * @var string
     * @since 1.0.0
     */
    public const MODULE_NAME = '';

    /**
     * Module path.
     *
     * @var string
     * @since 1.0.0
     */
    public const MODULE_PATH = __DIR__ . '/../../Modules';

    /**
     * Module version.
     *
     * @var string
     * @since 1.0.0
     */
    public const MODULE_VERSION = '1.0.0';

    /**
     * Module id.
     *
     * @var string
     * @since 1.0.0
     */
    public const MODULE_ID = 0;

    /**
     * Receiving modules from?
     *
     * @var string[]
     * @since 1.0.0
     */
    protected static $providing = [];
    /**
     * Localization files.
     *
     * @var array
     * @since 1.0.0
     */
    protected static $localization = [];
    /**
     * Dependencies.
     *
     * @var string[]
     * @since 1.0.0
     */
    protected static $dependencies = [];
    /**
     * Receiving modules from?
     *
     * @var string[]
     * @since 1.0.0
     */
    protected $receiving = [];
    /**
     * Application instance.
     *
     * @var \phpOMS\ApplicationAbstract
     * @since 1.0.0
     */
    protected $app = null;

    /**
     * Constructor.
     *
     * @param \phpOMS\ApplicationAbstract $app Application instance
     *
     * @since  1.0.0
     */
    public function __construct($app)
    {
        $this->app = $app;
    }

    /**
     * Get language files.
     *
     * @param string $language    Language key
     * @param string $destination Application destination (e.g. Backend)
     *
     * @return array<string, array<string, string>>
     *
     * @since  1.0.0
     */
    public static function getLocalization(string $language, string $destination) : array
    {
        $lang = [];
        if (\file_exists($oldPath = __DIR__ . '/../../Modules/' . static::MODULE_NAME . '/Theme/' . $destination . '/Lang/' . $language . '.lang.php')) {
            /** @noinspection PhpIncludeInspection */
            return include $oldPath;
        }

        return $lang;
    }

    /**
     * Add modules this module receives from
     *
     * @param string $module Module name
     *
     * @return void
     *
     * @since  1.0.0
     */
    public function addReceiving(string $module) : void
    {
        $this->receiving[] = $module;
    }

    /**
     * Get modules this module is providing for
     *
     * @return array<int, string>
     *
     * @since  1.0.0
     */
    public function getProviding() : array
    {
        /** @noinspection PhpUndefinedFieldInspection */
        return static::$providing;
    }

    /**
     * Get the name of the module
     *
     * @return string
     *
     * @since  1.0.0
     */
    public function getName() : string
    {
        /** @noinspection PhpUndefinedFieldInspection */
        return static::MODULE_NAME;
    }

    /**
     * Get module dependencies
     *
     * @return array
     *
     * @since  1.0.0
     */
    public function getDependencies() : array
    {
        /** @noinspection PhpUndefinedFieldInspection */
        return static::$dependencies;
    }

    /**
     * Fills the response object
     *
     * @param RequestAbstract  $request  Request
     * @param ResponseAbstract $response Response
     * @param string           $status   Response status
     * @param string           $title    Response title
     * @param string           $message  Response message
     * @param mixed            $obj      Response object
     *
     * @return void
     *
     * @since  1.0.0
     */
    protected function fillJsonResponse(
        RequestAbstract $request,
        ResponseAbstract $response,
        string $status,
        string $title,
        string $message,
        $obj
    ) : void
    {
        $response->getHeader()->set('Content-Type', MimeType::M_JSON . '; charset=utf-8', true);
        $response->set($request->getUri()->__toString(), [
            'status' => $status,
            'title' => $title,
            'message' => $message,
            'response' => $obj,
        ]);
    }

    /**
     * Fills the response object
     *
     * @param RequestAbstract  $request  Request
     * @param ResponseAbstract $response Response
     * @param mixed            $obj      Response object
     *
     * @return void
     *
     * @since  1.0.0
     */
    protected function fillJsonRawResponse(RequestAbstract $request, ResponseAbstract $response, $obj) : void
    {
        $response->getHeader()->set('Content-Type', MimeType::M_JSON . '; charset=utf-8', true);
        $response->set($request->getUri()->__toString(), $obj);
    }

    /**
     * Create a model
     *
     * @param RequestAbstract $request  Request
     * @param mixed           $obj      Response object
     * @param string          $mapper   Object mapper
     * @param string          $trigger  Trigger for the event manager
     *
     * @return void
     *
     * @since  1.0.0
     */
    protected function createModel(RequestAbstract $request, $obj, string $mapper, string $trigger) : void
    {
        $this->app->eventManager->trigger('PRE:Module:' . self::MODULE_NAME . '-' . $trigger . '-create', '', $obj);
        $mapper::create($obj);
        $this->app->eventManager->trigger('POST:Module:' . self::MODULE_NAME . '-' . $trigger . '-create', '', [
            $request->getHEader()->getAccount(),
            null,
            $obj,
        ]);
    }

    /**
     * Update a model
     *
     * @param RequestAbstract $request  Request
     * @param mixed           $old      Response object old
     * @param mixed           $new      Response object new
     * @param string|\Closure $mapper   Object mapper
     * @param string          $trigger  Trigger for the event manager
     *
     * @return void
     *
     * @since  1.0.0
     */
    protected function updateModel(RequestAbstract $request, $old, $new, $mapper, string $trigger) : void
    {
        $this->app->eventManager->trigger('PRE:Module:' . self::MODULE_NAME . '-' . $trigger . '-update', '', $old);
        if (\is_string($mapper)) {
            $mapper::update($new);
        } elseif ($mapper instanceof \Closure) {
            $mapper();
        }
        $this->app->eventManager->trigger('POST:Module:' . self::MODULE_NAME . '-' . $trigger . '-update', '', [
            $request->getHEader()->getAccount(),
            $old,
            $new,
        ]);
    }

    /**
     * Delete a model
     *
     * @param RequestAbstract $request  Request
     * @param mixed           $obj      Response object
     * @param string          $mapper   Object mapper
     * @param string          $trigger  Trigger for the event manager
     *
     * @return void
     *
     * @since  1.0.0
     */
    protected function deleteModel(RequestAbstract $request, $obj, string $mapper, string $trigger) : void
    {
        $this->app->eventManager->trigger('PRE:Module:' . self::MODULE_NAME . '-' . $trigger . '-delete', '', $obj);
        $mapper::delete($obj);
        $this->app->eventManager->trigger('POST:Module:' . self::MODULE_NAME . '-' . $trigger . '-delete', '', [
            $request->getHEader()->getAccount(),
            $obj,
            null,
        ]);
    }

    /**
     * Create a model relation
     *
     * @param RequestAbstract $request  Request
     * @param mixed           $rel1     Response object relation1
     * @param mixed           $rel2     Response object relation2
     * @param string          $mapper   Object mapper
     * @param string          $field    Relation field
     * @param string          $trigger  Trigger for the event manager
     *
     * @return void
     *
     * @since  1.0.0
     */
    protected function createModelRelation(RequestAbstract $request, $rel1, $rel2, string $mapper, string $field, string $trigger) : void
    {
        $this->app->eventManager->trigger('PRE:Module:' . self::MODULE_NAME . '-' . $trigger . '-relation', '', $rel1);
        $mapper::createRelation($field, $rel1, $rel2);
        $this->app->eventManager->trigger('POST:Module:' . self::MODULE_NAME . '-' . $trigger . '-relation', '', [
            $request->getHEader()->getAccount(),
            $rel1,
            $rel2,
        ]);
    }
}