RichTextConvertingEntity::getHtmlForField() - Code Metrics - Inspection of "add tests for more traits; fix the RelationTravers..." - kaliop/ezobjectwrapper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6eb5ff...dab245 )

by Gaetano

created 2017-01-17 13:59 UTC

RichTextConvertingEntity::getHtmlForField() A

↳ Parent: RichTextConvertingEntity

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	0
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php

namespace Kaliop\eZObjectWrapperBundle\Core\Traits;

use eZ\Publish\Core\FieldType\XmlText\Converter;

/**
 * Adds the capability to generate html version of RichText fields
 */
trait RichTextConvertingEntity
{
    protected $richTextConverter;

    /**
     * @param Converter $richTextConverter
     * @return $this
     */
    public function setRichTextConverter(Converter $richTextConverter)
    {
        $this->richTextConverter = $richTextConverter;
        return $this; // fluent interfaces for setters
    }

    /**
     * @param string $xml the value of an xml-text field
     * @return string
     */
    protected function getHtml($xml)
    {
        return $this->richTextConverter->convert($xml);
    }

    /**
     * @param $fieldName the identifier of an xml-text field
     * @return string
     */
    protected function getHtmlForField($fieldName)
    {
        return $this->getHtml($this->content()->getFieldValue($fieldName)->xml);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1			<?php
2
3			namespace Kaliop\eZObjectWrapperBundle\Core\Traits;
4
5			use eZ\Publish\Core\FieldType\XmlText\Converter;
6
7			/**
8			* Adds the capability to generate html version of RichText fields
9			*/
10			trait RichTextConvertingEntity
11			{
12			protected $richTextConverter;
13
14			/**
15			* @param Converter $richTextConverter
16			* @return $this
17			*/
18			public function setRichTextConverter(Converter $richTextConverter)
19			{
20			$this->richTextConverter = $richTextConverter;
21			return $this; // fluent interfaces for setters
22			}
23
24			/**
25			* @param string $xml the value of an xml-text field
26			* @return string
27			*/
28			protected function getHtml($xml)
29			{
30			return $this->richTextConverter->convert($xml);
31			}
32
33			/**
34			* @param $fieldName the identifier of an xml-text field
35			* @return string
36			*/
37			protected function getHtmlForField($fieldName)
38			{
39			return $this->getHtml($this->content()->getFieldValue($fieldName)->xml);
			0 ignored issues – show Bug introduced 2017-01-17 14:10 UTC by Report Bug Copy Issue Report It seems like `content()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
40			}
41			}
42

kaliop / ezobjectwrapper

Push — master ( 6eb5ff...dab245 )

RichTextConvertingEntity::getHtmlForField() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like