html_go\model\AdminModelFactory

Complexity

Total Complexity

11

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getSiteObject()	0	15	2
A	mergeStdClassAndArray()	0	5	2
A	createAdminContentObject()	0	15	3
A	createAdminContentObjectEmpty()	0	8	1
A	checkSetOrFail()	0	3	2
A	__construct()	0	2	1

<?php declare(strict_types=1);
namespace html_go\model;

use html_go\exceptions\InternalException;

abstract class AdminModelFactory
{
    protected Config $config;

    public function __construct(Config $config) {
        $this->config = $config;
    }

    /**
     * Create a content object (stdClass) specifically for the admin console.
     * @param array<mixed> $params When populating with variable arguments, use the following
     * <b>named parameters<b>:
     * <ul>
     *   <li>title: (required)</li>
     *   <li>context: (required)</li>
     *   <li>template: (required)</li>
     *   <li>section: (required)</li>
     *   <li>action: (required)</li>
     *   <li>list: (optional)</li>
     * </ul>
     * @return \stdClass
     */
    public function createAdminContentObject(array $params): \stdClass {
        $contentObject = new \stdClass();
        $this->checkSetOrFail('title', $params);
        $this->checkSetOrFail('context', $params);
        $this->checkSetOrFail('template', $params);
        $this->checkSetOrFail('section', $params);
        $this->checkSetOrFail('action', $params);

        $contentObject->site = $this->getSiteObject();
        $list = [];
        if (empty($params['list']) === false && \is_array($params['list'])) {

The condition is_array($params['list']) is always false.

            $list = $params['list'];
        }
        $contentObject->list = $list;
        return $this->mergeStdClassAndArray($contentObject, $params);
    }

    /**
     * Create a content object (stdClass) which has all the basic admin related properties, but
     * nothing for the specific request.
     * @param array<mixed> $params
     * @return \stdClass
     */
    public function createAdminContentObjectEmpty(array $params): \stdClass {
        $contentObject = new \stdClass();
        $this->checkSetOrFail('context', $params);
        $this->checkSetOrFail('section', $params);
        $this->checkSetOrFail('action', $params);
        $contentObject->site = $this->getSiteObject();
        $contentObject->list = [];
        return $this->mergeStdClassAndArray($contentObject, $params);
    }

    /**
     * @param \stdClass $contentObject
     * @param array<mixed> $params
     * @throws InternalException
     * @return \stdClass
     */
    private function mergeStdClassAndArray(\stdClass $contentObject, array $params): \stdClass {
        if (($json = json_encode($contentObject)) === false) {
            throw new InternalException('json_encode failed!');
        }
        return (object)\array_merge(json_decode($json, true), $params);
    }

    /**
     *
     * @param string $key
     * @param array<string> $params
     * @throws \InvalidArgumentException
     */
    private function checkSetOrFail(string $key, array $params): void {
        if (empty($params[$key])) {
            throw new \InvalidArgumentException("The '$key:' parameter has not been set!");
        }
    }

    protected function getSiteObject(): \stdClass {
        static $site = null;
        if (empty($site)) {
            $site = new \stdClass();
            $site->url = $this->config->getString(Config::KEY_SITE_URL);
            $site->name = $this->config->getString(Config::KEY_SITE_NAME);
            $site->title = $this->config->getString(Config::KEY_SITE_TITLE);
            $site->description = $this->config->getString(Config::KEY_SITE_DESCRIPTION);
            $site->tagline = $this->config->getString(Config::KEY_SITE_TAGLINE);
            $site->copyright = $this->config->getString(Config::KEY_SITE_COPYRIGHT);
            $site->language = $this->config->getString(Config::KEY_LANG);
            $site->theme = $this->config->getString(Config::KEY_THEME_NAME);
            $site->tpl_engine = $this->config->getString(Config::KEY_TPL_ENGINE);
        }
        return $site;
    }
}