O2System\Framework\Http\View

Complexity

Total Complexity

59

Size/Duplication

Total Lines	394
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	with()	0	9	2
A	parse()	0	5	1
B	load()	0	59	8
A	__construct()	0	22	2
A	__get()	0	9	2
A	modal()	0	14	4
B	page()	0	26	7
C	getFilePath()	0	70	12
F	render()	0	127	21

<?php
/**
 * This file is part of the O2System PHP Framework package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author         Steeve Andrian Salim
 * @copyright      Copyright (c) Steeve Andrian Salim
 */

// ------------------------------------------------------------------------

namespace O2System\Framework\Http;

// ------------------------------------------------------------------------

use O2System\Cache\Item;
use O2System\Framework\Http\Presenter\Meta;
use O2System\Framework\Http\Router\Datastructures\Page;
use O2System\Gear\Toolbar;
use O2System\Html;
use O2System\Psr\Cache\CacheItemPoolInterface;
use O2System\Psr\Patterns\Structural\Composite\RenderableInterface;
use O2System\Spl\Exceptions\ErrorException;
use O2System\Spl\Traits\Collectors\FileExtensionCollectorTrait;
use O2System\Spl\Traits\Collectors\FilePathCollectorTrait;

/**
 * Class View
 *
 * @package O2System
 */
class View implements RenderableInterface
{
    use FilePathCollectorTrait;
    use FileExtensionCollectorTrait;

    /**
     * View Config
     *
     * @var \O2System\Kernel\Datastructures\Config
     */
    protected $config;

    /**
     * View HTML Document
     *
     * @var Html\Document
     */
    protected $document;

    // ------------------------------------------------------------------------

    /**
     * View::__construct
     *
     * @return View
     */
    public function __construct()
    {
        $this->setFileDirName('Views');
        $this->addFilePath(PATH_APP);

        output()->addFilePath(PATH_APP);

        $this->config = config()->loadFile('view', true);

The method loadFile() does not exist on O2System\Kernel\Datastructures\Config.

It seems like config()->loadFile('view', true) can also be of type false. However, the property $config is declared as type O2System\Kernel\Datastructures\Config. Maybe add an additional type check?

        $this->setFileExtensions(
            [
                '.php',
                '.phtml',
            ]
        );

        if ($this->config->offsetExists('extensions')) {
            $this->setFileExtensions($this->config[ 'extensions' ]);
        }

        $this->document = new Html\Document();
        $this->document->formatOutput = (bool)$this->config->beautify;
    }

    /**
     * __get
     *
     * @param $property
     *
     * @return Parser|bool   Returns FALSE when property is not set.
     */
    public function &__get($property)
    {
        $get[ $property ] = false;

$get was never initialized. Although not strictly required by PHP, it is generally a good practice to add $get = array(); before regardless.

        if (property_exists($this, $property)) {
            return $this->{$property};
        }

        return $get[ $property ];
    }

    public function parse($string, array $vars = [])
    {
        parser()->loadString($string);

        return parser()->parse($vars);
    }

    public function with($vars, $value = null)
    {
        if (is_string($vars)) {
            $vars = [$vars => $value];
        }

        presenter()->merge($vars);

        return $this;
    }

    public function load($filename, array $vars = [], $return = false)
    {
        if ($filename instanceof Page) {
            return $this->page($filename->getRealPath(), array_merge($vars, $filename->getVars()));

$filename->getVars() of type O2System\Spl\Datastructures\SplArrayObject is incompatible with the type array|null expected by parameter $array2 of array_merge().

Are you sure the usage of $this->page($filename->getRealPath(), array_merge($vars, $filename->getVars())) targeting O2System\Framework\Http\View::page() seems to always return null.

        }

        if (strpos($filename, 'Pages') !== false) {
            return $this->page($filename, $vars, $return);
        }

        presenter()->merge($vars);

        if (false !== ($filePath = $this->getFilePath($filename))) {
            if ($return === false) {

                $partials = presenter()->get('partials');

                if ($partials->hasPartial('content') === false) {
                    $partials->addPartial('content', $filePath);
                } else {
                    $partials->addPartial(pathinfo($filePath, PATHINFO_FILENAME), $filePath);
                }
            } else {
                parser()->loadFile($filePath);

                return parser()->parse(presenter()->getArrayCopy());
            }
        } else {
            $vars = presenter()->getArrayCopy();
            extract($vars);

            $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);

            $error = new ErrorException(
                'E_VIEW_NOT_FOUND',
                0,
                @$backtrace[ 0 ][ 'file' ],
                @$backtrace[ 0 ][ 'line' ],
                [trim($filename)]
            );

            unset($backtrace);

            ob_start();
            include output()->getFilePath('error');

The method getFilePath() does not exist on O2System\Kernel\Cli\Output. Did you maybe mean getFilePaths()?

            $content = ob_get_contents();
            ob_end_clean();

            if ($return === false) {
                $partials = presenter()->get('partials');

                if ($partials->hasPartial('content') === false) {
                    $partials->addPartial('content', $content);
                } else {
                    $partials->addPartial(pathinfo($filePath, PATHINFO_FILENAME), $content);

It seems like $filePath can also be of type false; however, parameter $path of pathinfo() does only seem to accept string, maybe add an additional type check?

                }

            } else {
                return $content;
            }
        }
    }

    public function page($filename, array $vars = [], $return = false)
    {
        if ($filename instanceof Page) {
            return $this->page($filename->getRealPath(), array_merge($vars, $filename->getVars()));

Are you sure the usage of $this->page($filename->getRealPath(), array_merge($vars, $filename->getVars())) targeting O2System\Framework\Http\View::page() seems to always return null.

$filename->getVars() of type O2System\Spl\Datastructures\SplArrayObject is incompatible with the type array|null expected by parameter $array2 of array_merge().

        } else {
            $pageDirectories = modules()->getDirs('Pages');

The method getDirs() does not exist on O2System\Framework\Datastructures\Module. Did you maybe mean getDir()?

            foreach ($pageDirectories as $pageDirectory) {
                if (is_file($pageFilePath = $pageDirectory . $filename . '.phtml')) {
                    $filename = $pageFilePath;
                    break;
                }
            }
        }

        presenter()->merge($vars);

        if ($return === false) {
            $partials = presenter()->get('partials');

            if ($partials->hasPartial('content') === false) {
                $partials->addPartial('content', $filename);
            } else {
                $partials->addPartial(pathinfo($filename, PATHINFO_FILENAME), $filename);
            }
        } elseif (parser()->loadFile($filename)) {
            return parser()->parse(presenter()->getArrayCopy());
        }
    }

    public function modal($filename, array $vars = [])
    {
        if (presenter()->theme->hasLayout('modal')) {

The property theme does not exist on O2System\Framework\Http\Presenter. Since you implemented __get, consider adding a @property annotation.

The method hasLayout() does not exist on null.

            if (presenter()->theme->hasLayout('modal')) {
                presenter()->theme->setLayout('modal');
                echo $this->load($filename, $vars, true);
                exit(EXIT_SUCCESS);

Using exit here is not recommended.

            }
        }

        presenter()->merge($vars);

        if (parser()->loadFile($filename)) {
            output()->send(parser()->parse(presenter()->getArrayCopy()));

The method send() does not exist on O2System\Kernel\Cli\Output.

        }
    }

    public function getFilePath($filename)
    {
        $filename = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $filename);

        if (is_file($filename)) {
            return realpath($filename);
        } else {
            $viewsFileExtensions = $this->fileExtensions;
            $viewsDirectories = modules()->getDirs('Views');
            $viewsDirectories = array_merge($viewsDirectories, $this->filePaths);
            $viewsDirectories = array_unique($viewsDirectories);

            $deviceDirectory = null;

The assignment to $deviceDirectory is dead and can be removed.

            if (services('userAgent')->isMobile()) {

The method isMobile() does not exist on O2System\Kernel\Containers\Services.

                $deviceDirectory = 'mobile';
            }

            if (presenter()->theme->use === true) {

The property theme does not exist on O2System\Framework\Http\Presenter. Since you implemented __get, consider adding a @property annotation.

                $moduleReplacementPath = presenter()->theme->active->getPathName()
                    . DIRECTORY_SEPARATOR
                    . 'views'
                    . DIRECTORY_SEPARATOR
                    . strtolower(
                        str_replace(PATH_APP, '', modules()->current()->getRealpath())

The method current() does not exist on O2System\Framework\Datastructures\Module.

                    );

                if (is_dir($moduleReplacementPath)) {
                    array_unshift($viewsDirectories, $moduleReplacementPath);

                    // Add Theme File Extensions
                    if (presenter()->theme->active->getPresets()->offsetExists('extension')) {
                        array_unshift($viewsFileExtensions,
                            presenter()->theme->active->getPresets()->offsetGet('extension'));
                    } elseif (presenter()->theme->active->getPresets()->offsetExists('extensions')) {
                        $viewsFileExtensions = array_merge(
                            presenter()->theme->active->getPresets()->offsetGet('extensions'),
                            $viewsFileExtensions
                        );
                    }

                    // Add Theme Parser Engine
                    if (presenter()->theme->active->getPresets()->offsetExists('driver')) {
                        $parserDriverClassName = '\O2System\Parser\Drivers\\' . camelcase(
                                presenter()->theme->active->getPresets()->offsetGet('driver')
                            );

                        if (class_exists($parserDriverClassName)) {
                            parser()->addDriver(
                                new $parserDriverClassName(),
                                presenter()->theme->active->getPresets()->offsetGet('driver')
                            );
                        }
                    }
                }
            }

            foreach ($viewsDirectories as $viewsDirectory) {
                foreach ($viewsFileExtensions as $fileExtension) {
                    $filename = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $filename);

                    if (is_file($filePath = $viewsDirectory . $filename . $fileExtension)) {
                        return realpath($filePath);
                        break;

break is not strictly necessary here and could be removed.

                    }
                }
            }
        }

        return false;
    }

    public function render(array $options = [])
    {
        if(profiler() !== false) {

The condition profiler() !== false is always true.

            profiler()->watch('Starting View Rendering');
        }
        
        $htmlOutput = '';
        parser()->loadVars(presenter()->getArrayCopy());

        // set document meta title
        if (presenter()->meta->title instanceof Meta\Title) {

The property meta does not exist on O2System\Framework\Http\Presenter. Since you implemented __get, consider adding a @property annotation.

            $this->document->title->text(presenter()->meta->title->__toString());
        }

        /**
         * Injecting Meta Opengraph
         */
        if (presenter()->meta->opengraph instanceof Meta\Opengraph) {
            // set opengraph title
            if (presenter()->meta->title instanceof Meta\Title) {
                presenter()->meta->opengraph->setTitle(presenter()->meta->title->__toString());
            }

            // set opengraph site name
            if (presenter()->exists('siteName')) {
                presenter()->meta->opengraph->setSiteName(presenter()->offsetGet('siteName'));
            }

            if (presenter()->meta->opengraph->count()) {
                $htmlElement = $this->document->getElementsByTagName('html')->item(0);
                $htmlElement->setAttribute('prefix', 'og: ' . presenter()->meta->opengraph->prefix);

                if (presenter()->meta->opengraph->exists('og:type') === false) {
                    presenter()->meta->opengraph->setType('website');
                }

                $opengraph = presenter()->meta->opengraph->getArrayCopy();

                foreach ($opengraph as $tag) {
                    $this->document->metaNodes->createElement($tag->attributes->getArrayCopy());
                }
            }
        }

        if (false !== ($controller = controller())) {
            presenter()->meta->offsetSet('module-controller', $controller->getClassInfo()->getParameter());

The method offsetSet() does not exist on null.

        }

        $meta = presenter()->meta->getArrayCopy();

        foreach ($meta as $tag) {
            $this->document->metaNodes->createElement($tag->attributes->getArrayCopy());
        }

        if (presenter()->theme->use === true) {

The property theme does not exist on O2System\Framework\Http\Presenter. Since you implemented __get, consider adding a @property annotation.

            presenter()->theme->load();
            if (false !== ($layout = presenter()->theme->active->getLayout())) {
                parser()->loadFile($layout->getRealPath());
                $htmlOutput = parser()->parse();
            }
        } else {
            $this->document->find('body')->append(presenter()->partials->__get('content'));

The method __get() does not exist on null.

The property partials does not exist on O2System\Framework\Http\Presenter. Since you implemented __get, consider adding a @property annotation.

        }

        $this->document->loadHTML(presenter()->assets->parseSourceCode($htmlOutput));

The method parseSourceCode() does not exist on null.

The property assets does not exist on O2System\Framework\Http\Presenter. Since you implemented __get, consider adding a @property annotation.

        
        /**
         * Injecting Single Sign-On (SSO) iFrame
         */
        if (services()->has('user')) {
            $iframe = services()->get('user')->getIframeCode();

            if ( ! empty($iframe)) {
                $this->document->find('body')->append($iframe);
            }
        }

        if (input()->env('DEBUG_STAGE') === 'DEVELOPER' and
            config()->getItem('presenter')->debugToolBar === true and

The method getItem() does not exist on O2System\Kernel\Datastructures\Config. Did you maybe mean getIterator()?

            services()->has('profiler')
        ) {
            $this->document->find('body')->append((new Toolbar())->__toString());
        }

        /**
         * Injecting Progressive Web Application (PWA) Manifest
         */
        $this->document->linkNodes->createElement([
            'rel'  => 'manifest',
            'href' => '/manifest.json',
        ]);

        $htmlOutput = $this->document->saveHTML();

        // Uglify Output
        if ($this->config->output['uglify'] === true) {
            $htmlOutput = preg_replace(
                [
                    '/\>[^\S ]+/s',     // strip whitespaces after tags, except space
                    '/[^\S ]+\</s',     // strip whitespaces before tags, except space
                    '/(\s)+/s',         // shorten multiple whitespace sequences
                    '/<!--(.|\s)*?-->/', // Remove HTML comments
                    '/<!--(.*)-->/Uis',
                    "/[[:blank:]]+/",
                ],
                [
                    '>',
                    '<',
                    '\\1',
                    '',
                    '',
                    ' ',
                ],
                str_replace(["\n", "\r", "\t"], '', $htmlOutput));
        }

        // Beautify Output
        if ($this->config->output['beautify'] === true) {
            $beautifier = new Html\Dom\Beautifier();
            $htmlOutput = $beautifier->format($htmlOutput);
        }

        if(profiler() !== false) {

The condition profiler() !== false is always true.

            profiler()->watch('Ending View Rendering');
        }

        return $htmlOutput;
    }
}