AframeVR\Core\DOM\AframeDOMProcessor

Complexity

Total Complexity

16

Size/Duplication

Total Lines	168
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	appendFormatComment()	0	7	2
A	correctOutputFormat()	0	18	1
A	renderHead()	0	7	1
A	appendDefaultMetaTags()	0	9	2
A	getDefaultMetaTags()	0	17	1
A	appendCDN()	0	8	2
A	renderBody()	0	4	1
A	appendMetaTag()	0	7	2
A	createDocType()	0	4	1
A	createAframeDocument()	0	4	1
A	documentBootstrap()	0	11	2

<?php
/** @formatter:off
 * ******************************************************************
 * Created by   Marko Kungla on Jun 29, 2016 - 8:06:17 AM
 * Contact      marko@okramlabs.com
 * @copyright   2016 Marko Kungla - https://github.com/mkungla
 * @license     The MIT License (MIT)
 * 
 * @category       AframeVR
 * @package        aframe-php
 * 
 * Lang         PHP (php version >= 7)
 * Encoding     UTF-8
 * File         AframeDOMProcessor.php
 * Code format  PSR-2 and 12
 * @link        https://github.com/mkungla/aframe-php
 ^ @issues      https://github.com/mkungla/aframe-php/issues
 * ********************************************************************
 * Contributors:
 * @author Marko Kungla <marko@okramlabs.com>
 * ********************************************************************
 * Comments:
 * @formatter:on */
namespace AframeVR\Core\DOM;

trait AframeDOMProcessor
{

    /**
     * Add document comment for formatting
     *
     * @param string $element            
     * @param string $comment            
     */
    protected function appendFormatComment(string $element, string $comment)
    {
        if ($this->formatOutput) {

The property formatOutput does not exist. Did you maybe forget to declare it?

            $com = $this->docObj->createComment($comment);

The property docObj does not exist. Did you maybe forget to declare it?

            $this->{$element}->appendChild($com);
        }
    }

    /**
     * Correct html format for tags which are not supported by DOMDocument
     *
     * @param string $html            
     * @return string
     */
    protected function correctOutputFormat($html)
    {
        $tags = array(

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

            '<!--',
            '-->',
            '<a-assets>',
            '</a-assets>',
            '</a-scene>'
        );
        $values = array(
            '',
            "\t",
            "\n\t<a-assets>",
            "\n\t</a-assets>",
            "\n</a-scene>"
        );
        return str_ireplace($tags, $values, $html);
    }

    /**
     * Prepeare head
     *
     * @return void
     */
    protected function renderHead()
    {
        $title = $this->docObj->createElement('title', $this->scene_title);

The property scene_title does not exist. Did you maybe forget to declare it?

        $this->head->appendChild($title);

The property head does not exist. Did you maybe forget to declare it?

        $this->appendDefaultMetaTags();
        $this->appendCDN();
    }

    /**
     * Append deffault metatags
     *
     * @return void
     */
    protected function appendDefaultMetaTags()
    {
        $this->appendMetaTag(array(
            'name' => 'description',
            'content' => $this->scene_description

The property scene_description does not exist. Did you maybe forget to declare it?

        ));
        foreach ($this->getDefaultMetaTags() as $tag)
            $this->appendMetaTag($tag);
    }

    /**
     * Get default meta tags
     *
     * @return array
     */
    protected function getDefaultMetaTags(): array
    {
        $dmt = array();

Equals sign not aligned with surrounding assignments; expected 15 spaces but found 1 space

        $dmt[0]['charset'] = 'utf-8';
        
        $dmt[1]['name'] = 'viewport';
        
        $vp = 'width=device-width,initial-scale=1,maximum-scale=1,shrink-to-fit=no,user-scalable=no,minimal-ui';
        
        $dmt[1]['content'] = $vp;
        $dmt[2]['name'] = 'mobile-web-app-capable';

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

        $dmt[2]['content'] = 'yes';
        $dmt[3]['name'] = 'theme-color';

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

        $dmt[3]['content'] = 'black';
        
        return $dmt;
    }

    /**
     * If requested by user use aframe CDN
     *
     * @return void
     */
    protected function appendCDN()
    {
        if ($this->use_cdn) {

The property use_cdn does not exist. Did you maybe forget to declare it?

            $cdn_script = $this->docObj->createElement('script');
            $cdn_script->setAttribute('src', $this->aframe_cdn);

The property aframe_cdn does not exist. Did you maybe forget to declare it?

            $this->head->appendChild($cdn_script);
        }
    }

    /**
     * Prepare body
     *
     * @return void
     */
    protected function renderBody()
    {
        $this->body->appendChild($this->scene);

The property body does not exist. Did you maybe forget to declare it?

The property scene does not exist. Did you maybe forget to declare it?

    }

    /**
     * Create meta tags
     *
     * @param array $attr            
     */
    protected function appendMetaTag(array $attr)
    {
        $metatag = $this->docObj->createElement('meta');
        foreach ($attr as $key => $val)
            $metatag->setAttribute($key, $val);
        $this->head->appendChild($metatag);
    }

    /**
     * Creates an empty DOMDocumentType object
     *
     * @param string $doctype            
     * @return void
     */
    protected function createDocType(string $doctype)
    {
        $this->doctypeObj = $this->createDocumentType($doctype);

The property doctypeObj does not exist. Did you maybe forget to declare it?

It seems like createDocumentType() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Creates a DOMDocument object of the specified type with its document element
     *
     * @return void
     */
    protected function createAframeDocument()
    {
        $this->docObj = $this->createDocument(null, 'html', $this->doctypeObj);

It seems like createDocument() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Create dom elements for DOMDocument
     *
     * @return void
     */
    protected function documentBootstrap()
    {
        /* Create <head> element */
        $this->head = $this->docObj->createElement('head');
        /* Create <body> element */
        $this->body = $this->docObj->createElement('body', $this->formatOutput ? "\n" : '');
        /* Create <a-scene> element */
        $this->scene = $this->docObj->createElement('a-scene');
        /* Create <a-assets> element */
        $this->assets = $this->docObj->createElement('a-assets');

The property assets does not exist. Did you maybe forget to declare it?

    }
}