DocumentMapper - Code Metrics - Inspection of "EZP-26494: remove backslashes from fixture" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — EZP-26494 ( 820e2b...591f1b )

unknown

created 2016-12-15 13:43 UTC

DocumentMapper A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

Metric	Value
dl	0
loc	26
rs	10
c	0
b	0
f	0
wmc	2
lcom	0
cbo	2

2 Methods

Rating	Name	Duplication	Size	Complexity
A	canMap()	0	4	1
A	map()	0	4	1

<?php

/**
 * File containing the DocumentMapper document field value mapper class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 *
 * @version //autogentag//
 */
namespace eZ\Publish\Core\Search\Elasticsearch\Content\FieldValueMapper;

use eZ\Publish\Core\Search\Elasticsearch\Content\FieldValueMapper;
use eZ\Publish\SPI\Search\FieldType\DocumentField;
use eZ\Publish\SPI\Search\Field;

/**
 * Maps DocumentField document field values to something Elasticsearch can index.
 */
class DocumentMapper extends FieldValueMapper
{
    /**
     * Check if field can be mapped.
     *
     * @param \eZ\Publish\SPI\Search\Field $field
     *
     * @return bool
     */
    public function canMap(Field $field)
    {
        return $field->type instanceof DocumentField;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Map field value to a proper Elasticsearch representation.
     *
     * @param \eZ\Publish\SPI\Search\Field $field
     *
     * @return mixed
     */
    public function map(Field $field)
    {
        return $field->value;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }
}


1			<?php
2
3			/**
4			* File containing the DocumentMapper document field value mapper class.
5			*
6			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7			* @license For full copyright and license information view LICENSE file distributed with this source code.
8			*
9			* @version //autogentag//
10			*/
11			namespace eZ\Publish\Core\Search\Elasticsearch\Content\FieldValueMapper;
12
13			use eZ\Publish\Core\Search\Elasticsearch\Content\FieldValueMapper;
14			use eZ\Publish\SPI\Search\FieldType\DocumentField;
15			use eZ\Publish\SPI\Search\Field;
16
17			/**
18			* Maps DocumentField document field values to something Elasticsearch can index.
19			*/
20			class DocumentMapper extends FieldValueMapper
21			{
22			/**
23			* Check if field can be mapped.
24			*
25			* @param \eZ\Publish\SPI\Search\Field $field
26			*
27			* @return bool
28			*/
29			public function canMap(Field $field)
30			{
31			return $field->type instanceof DocumentField;
			0 ignored issues – show Documentation introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The property `$type` is declared protected in `eZ\Publish\SPI\Search\Field`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
32			}
33
34			/**
35			* Map field value to a proper Elasticsearch representation.
36			*
37			* @param \eZ\Publish\SPI\Search\Field $field
38			*
39			* @return mixed
40			*/
41			public function map(Field $field)
42			{
43			return $field->value;
			0 ignored issues – show Documentation introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The property `$value` is declared protected in `eZ\Publish\SPI\Search\Field`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
44			}
45			}
46

ezsystems / ezpublish-kernel

Push — EZP-26494 ( 820e2b...591f1b )

DocumentMapper A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like