AbstractHtmlElement::returnBr() - Code Metrics - Inspection of "trying to publish to packagist, with no access to..." - pgee70/cda - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 26e0e4...4a85b9 )

by Peter

created 2018-08-31 11:09 UTC

AbstractHtmlElement::returnBr() A

↳ Parent: AbstractHtmlElement

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php

/**
 * The MIT License
 *
 * Copyright 2018  Peter Gee <https://github.com/pgee70>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/**
 *
 * @package     i3Soft\CDA
 * @author      Peter Gee <https://github.com/pgee70>
 * @link        https://github.com/pgee70/cda
 *
 */


namespace i3Soft\CDA\Elements\Html;


use i3Soft\CDA\Elements\AbstractElement;

abstract class AbstractHtmlElement extends AbstractElement
{
    /** @var string */
    protected $content;

    /** @var array */
    protected $tags;

    protected $tag_attributes;

    /**
     * AbstractHtmlElement constructor.
     *
     * @param string $choice
     */
    public function __construct($choice = '')
    {
        $this->tags           = array();
        $this->tag_attributes = array();
        if ($choice) {
            if (\is_string($choice)) {

                $this->setContent($choice);
            } else {
                $this->addTag($choice);
            }
        }
    }

    /**
     * @param $choice
     *
     * @return self
     */
    public function addTag($choice): self
    {
        if ($this->canAddTag($choice)) {
            $this->tags[] = $choice;
        }
        return $this;
    }

    /**
     * Checks to see if the choice can be added to the tags array of this class.
     *
     * @param $choice
     *
     * @return bool
     */
    abstract protected function canAddTag($choice): bool;

    /**
     * @inheritDoc
     */
    public function toDOMElement(\DOMDocument $doc): \DOMElement
    {
        $el = $this->createElement($doc, $this->tag_attributes);
        if ($this->hasContent()) {
            $el->appendChild($doc->createTextNode($this->getContent()));
        } else {
            foreach ($this->getTags() as $tag) {
                $el->appendChild($tag->toDOMElement($doc));
            }
        }
        return $el;
    }

    /**
     * @return bool
     */
    public function hasContent(): bool
    {
        return empty($this->content) === false;
    }

    /**
     * @return string
     */
    public function getContent(): string
    {
        return $this->content;
    }

    /**
     * @param string $content
     *
     * @return self
     */
    public function setContent(string $content): self
    {
        $this->content = $content;
        return $this;
    }

    /**
     * @return array
     */
    public function getTags(): array
    {
        return $this->tags;
    }

    /**
     * @param array $tags
     *
     * @return self
     */
    public function setTags(array $tags): self
    {
        $this->tags = $tags;
        return $this;
    }

    /**
     * @return Br
     */
    public function returnBr(): Br
    {
        if ($this instanceof Br) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Br');
    }

    /**
     * @return Caption
     */
    public function returnCaption(): Caption
    {
        if ($this instanceof Caption) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Caption');
    }

    /**
     * @return FootNote
     */
    public function returnFootNote(): FootNote
    {
        if ($this instanceof FootNote) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class FootNote');
    }

    /**
     * @return FootNoteRef
     */
    public function returnFootNoteRef(): FootNoteRef
    {
        if ($this instanceof FootNoteRef) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class FootNoteRef');
    }

    /**
     * @return Item
     */
    public function returnItem(): Item
    {
        if ($this instanceof Item) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Item');
    }

    /**
     * @return LinkHtml
     */
    public function returnLinkHtml(): LinkHtml
    {
        if ($this instanceof LinkHtml) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class LinkHtml');
    }

    /**
     * @return ListElement
     */
    public function returnListElement(): ListElement
    {
        if ($this instanceof ListElement) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class ListElement');
    }

    /**
     * @return Paragraph
     */
    public function returnParagraph(): Paragraph
    {
        if ($this instanceof Paragraph) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Paragraph');
    }

    /**
     * @return ReferenceElement
     */
    public function returnReferenceElement(): ReferenceElement
    {
        if ($this instanceof ReferenceElement) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class ReferenceElement');
    }

    /**
     * @return RenderMultiMedia
     */
    public function returnRenderMultiMedia(): RenderMultiMedia
    {
        if ($this instanceof RenderMultiMedia) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class RenderMultiMedia');
    }

    /**
     * @return Sub
     */
    public function returnSub(): Sub
    {
        if ($this instanceof Sub) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Sub');
    }

    /**
     * @return Sup
     */
    public function returnSup(): Sup
    {
        if ($this instanceof Sup) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Sup');
    }

    /**
     * @return Table
     */
    public function returnTable(): Table
    {
        if ($this instanceof Table) {

            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Table');
    }

    /**
     * @return TableBody
     */
    public function returnTableBody(): TableBody
    {
        if ($this instanceof TableBody) {

            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class TableBody');
    }

    /**
     * @return TableCell
     */
    public function returnTableCell(): TableCell
    {
        if ($this instanceof TableCell) {

            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class TableCell');
    }

    /**
     * @return TableHead
     */
    public function returnTableHead(): TableHead
    {
        if ($this instanceof TableHead) {

            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class TableHead');
    }

    /**
     * @return TableRow
     */
    public function returnTableRow(): TableRow
    {
        if ($this instanceof TableRow) {

            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class TableRow');
    }

    /**
     * @return Text
     */
    public function returnText(): Text
    {
        if ($this instanceof Text) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Text');
    }

    /**
     * @return Title
     */
    public function returnTitle(): Title
    {
        if ($this instanceof Title) {
            return $this;
        }
        throw new \RuntimeException('The element is not an instance of Class Title');
    }
}

1			<?php
2
3			/**
4			* The MIT License
5			*
6			* Copyright 2018 Peter Gee <https://github.com/pgee70>.
7			*
8			* Permission is hereby granted, free of charge, to any person obtaining a copy
9			* of this software and associated documentation files (the "Software"), to deal
10			* in the Software without restriction, including without limitation the rights
11			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12			* copies of the Software, and to permit persons to whom the Software is
13			* furnished to do so, subject to the following conditions:
14			*
15			* The above copyright notice and this permission notice shall be included in
16			* all copies or substantial portions of the Software.
17			*
18			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20			* FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
21			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24			* THE SOFTWARE.
25			*/
26
27			/**
28			*
29			* @package i3Soft\CDA
30			* @author Peter Gee <https://github.com/pgee70>
31			* @link https://github.com/pgee70/cda
32			*
33			*/
34
35
36			namespace i3Soft\CDA\Elements\Html;
37
38
39			use i3Soft\CDA\Elements\AbstractElement;
40
41			abstract class AbstractHtmlElement extends AbstractElement
42			{
43			/** @var string */
44			protected $content;
45
46			/** @var array */
47			protected $tags;
48
49			protected $tag_attributes;
50
51			/**
52			* AbstractHtmlElement constructor.
53			*
54			* @param string $choice
55			*/
56			public function __construct($choice = '')
57			{
58			$this->tags = array();
59			$this->tag_attributes = array();
60			if ($choice) {
61			if (\is_string($choice)) {
			0 ignored issues – show introduced 2018-08-28 13:17 UTC by Report Bug Copy Issue Report The condition `is_string($choice)` is always `true`. Loading history...
62			$this->setContent($choice);
63			} else {
64			$this->addTag($choice);
65			}
66			}
67			}
68
69			/**
70			* @param $choice
71			*
72			* @return self
73			*/
74			public function addTag($choice): self
75			{
76			if ($this->canAddTag($choice)) {
77			$this->tags[] = $choice;
78			}
79			return $this;
80			}
81
82			/**
83			* Checks to see if the choice can be added to the tags array of this class.
84			*
85			* @param $choice
86			*
87			* @return bool
88			*/
89			abstract protected function canAddTag($choice): bool;
90
91			/**
92			* @inheritDoc
93			*/
94			public function toDOMElement(\DOMDocument $doc): \DOMElement
95			{
96			$el = $this->createElement($doc, $this->tag_attributes);
97			if ($this->hasContent()) {
98			$el->appendChild($doc->createTextNode($this->getContent()));
99			} else {
100			foreach ($this->getTags() as $tag) {
101			$el->appendChild($tag->toDOMElement($doc));
102			}
103			}
104			return $el;
105			}
106
107			/**
108			* @return bool
109			*/
110			public function hasContent(): bool
111			{
112			return empty($this->content) === false;
113			}
114
115			/**
116			* @return string
117			*/
118			public function getContent(): string
119			{
120			return $this->content;
121			}
122
123			/**
124			* @param string $content
125			*
126			* @return self
127			*/
128			public function setContent(string $content): self
129			{
130			$this->content = $content;
131			return $this;
132			}
133
134			/**
135			* @return array
136			*/
137			public function getTags(): array
138			{
139			return $this->tags;
140			}
141
142			/**
143			* @param array $tags
144			*
145			* @return self
146			*/
147			public function setTags(array $tags): self
148			{
149			$this->tags = $tags;
150			return $this;
151			}
152
153			/**
154			* @return Br
155			*/
156			public function returnBr(): Br
157			{
158			if ($this instanceof Br) {
159			return $this;
160			}
161			throw new \RuntimeException('The element is not an instance of Class Br');
162			}
163
164			/**
165			* @return Caption
166			*/
167			public function returnCaption(): Caption
168			{
169			if ($this instanceof Caption) {
170			return $this;
171			}
172			throw new \RuntimeException('The element is not an instance of Class Caption');
173			}
174
175			/**
176			* @return FootNote
177			*/
178			public function returnFootNote(): FootNote
179			{
180			if ($this instanceof FootNote) {
181			return $this;
182			}
183			throw new \RuntimeException('The element is not an instance of Class FootNote');
184			}
185
186			/**
187			* @return FootNoteRef
188			*/
189			public function returnFootNoteRef(): FootNoteRef
190			{
191			if ($this instanceof FootNoteRef) {
192			return $this;
193			}
194			throw new \RuntimeException('The element is not an instance of Class FootNoteRef');
195			}
196
197			/**
198			* @return Item
199			*/
200			public function returnItem(): Item
201			{
202			if ($this instanceof Item) {
203			return $this;
204			}
205			throw new \RuntimeException('The element is not an instance of Class Item');
206			}
207
208			/**
209			* @return LinkHtml
210			*/
211			public function returnLinkHtml(): LinkHtml
212			{
213			if ($this instanceof LinkHtml) {
214			return $this;
215			}
216			throw new \RuntimeException('The element is not an instance of Class LinkHtml');
217			}
218
219			/**
220			* @return ListElement
221			*/
222			public function returnListElement(): ListElement
223			{
224			if ($this instanceof ListElement) {
225			return $this;
226			}
227			throw new \RuntimeException('The element is not an instance of Class ListElement');
228			}
229
230			/**
231			* @return Paragraph
232			*/
233			public function returnParagraph(): Paragraph
234			{
235			if ($this instanceof Paragraph) {
236			return $this;
237			}
238			throw new \RuntimeException('The element is not an instance of Class Paragraph');
239			}
240
241			/**
242			* @return ReferenceElement
243			*/
244			public function returnReferenceElement(): ReferenceElement
245			{
246			if ($this instanceof ReferenceElement) {
247			return $this;
248			}
249			throw new \RuntimeException('The element is not an instance of Class ReferenceElement');
250			}
251
252			/**
253			* @return RenderMultiMedia
254			*/
255			public function returnRenderMultiMedia(): RenderMultiMedia
256			{
257			if ($this instanceof RenderMultiMedia) {
258			return $this;
259			}
260			throw new \RuntimeException('The element is not an instance of Class RenderMultiMedia');
261			}
262
263			/**
264			* @return Sub
265			*/
266			public function returnSub(): Sub
267			{
268			if ($this instanceof Sub) {
269			return $this;
270			}
271			throw new \RuntimeException('The element is not an instance of Class Sub');
272			}
273
274			/**
275			* @return Sup
276			*/
277			public function returnSup(): Sup
278			{
279			if ($this instanceof Sup) {
280			return $this;
281			}
282			throw new \RuntimeException('The element is not an instance of Class Sup');
283			}
284
285			/**
286			* @return Table
287			*/
288			public function returnTable(): Table
289			{
290			if ($this instanceof Table) {
			0 ignored issues – show introduced 2018-08-31 11:20 UTC by Report Bug Copy Issue Report `$this` is never a sub-type of `i3Soft\CDA\Elements\Html\Table`. Loading history...
291			return $this;
292			}
293			throw new \RuntimeException('The element is not an instance of Class Table');
294			}
295
296			/**
297			* @return TableBody
298			*/
299			public function returnTableBody(): TableBody
300			{
301			if ($this instanceof TableBody) {
			0 ignored issues – show introduced 2018-08-31 11:20 UTC by Report Bug Copy Issue Report `$this` is never a sub-type of `i3Soft\CDA\Elements\Html\TableBody`. Loading history...
302			return $this;
303			}
304			throw new \RuntimeException('The element is not an instance of Class TableBody');
305			}
306
307			/**
308			* @return TableCell
309			*/
310			public function returnTableCell(): TableCell
311			{
312			if ($this instanceof TableCell) {
			0 ignored issues – show introduced 2018-08-31 11:20 UTC by Report Bug Copy Issue Report `$this` is never a sub-type of `i3Soft\CDA\Elements\Html\TableCell`. Loading history...
313			return $this;
314			}
315			throw new \RuntimeException('The element is not an instance of Class TableCell');
316			}
317
318			/**
319			* @return TableHead
320			*/
321			public function returnTableHead(): TableHead
322			{
323			if ($this instanceof TableHead) {
			0 ignored issues – show introduced 2018-08-31 11:20 UTC by Report Bug Copy Issue Report `$this` is never a sub-type of `i3Soft\CDA\Elements\Html\TableHead`. Loading history...
324			return $this;
325			}
326			throw new \RuntimeException('The element is not an instance of Class TableHead');
327			}
328
329			/**
330			* @return TableRow
331			*/
332			public function returnTableRow(): TableRow
333			{
334			if ($this instanceof TableRow) {
			0 ignored issues – show introduced 2018-08-31 11:20 UTC by Report Bug Copy Issue Report `$this` is never a sub-type of `i3Soft\CDA\Elements\Html\TableRow`. Loading history...
335			return $this;
336			}
337			throw new \RuntimeException('The element is not an instance of Class TableRow');
338			}
339
340			/**
341			* @return Text
342			*/
343			public function returnText(): Text
344			{
345			if ($this instanceof Text) {
346			return $this;
347			}
348			throw new \RuntimeException('The element is not an instance of Class Text');
349			}
350
351			/**
352			* @return Title
353			*/
354			public function returnTitle(): Title
355			{
356			if ($this instanceof Title) {
357			return $this;
358			}
359			throw new \RuntimeException('The element is not an instance of Class Title');
360			}
361			}

pgee70 / cda

Push — master ( 26e0e4...4a85b9 )

AbstractHtmlElement::returnBr() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like