PgEntity::fromPg() - Code Metrics - Inspection of "Added a findOneWhere() method which greatly simpli..." - pomm-project/ModelManager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#62)

unknown

created 2016-05-24 15:44 UTC

PgEntity::fromPg() B

↳ Parent: PgEntity

Complexity

Conditions	3
Paths	3

Size

Total Lines	24
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
c	4
b	1
f	0
dl	0
loc	24
rs	8.9713
cc	3
eloc	15
nc	3
nop	3

<?php
/*
 * This file is part of the PommProject/ModelManager package.
 *
 * (c) 2014 - 2015 Grégoire HUBERT <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PommProject\ModelManager\Converter;

use PommProject\Foundation\Converter\ConverterInterface;
use PommProject\Foundation\Exception\ConverterException;
use PommProject\Foundation\Session\Session;
use PommProject\ModelManager\Model\FlexibleEntity\FlexibleEntityInterface;
use PommProject\ModelManager\Model\HydrationPlan;
use PommProject\ModelManager\Model\IdentityMapper;
use PommProject\ModelManager\Model\Projection;
use PommProject\ModelManager\Model\RowStructure;

/**
 * PgEntity
 *
 * Entity converter.
 * It handles row types and composite types.
 *
 * @package   ModelManager
 * @copyright 2014 - 2015 Grégoire HUBERT
 * @author    Grégoire HUBERT
 * @license   X11 {@link http://opensource.org/licenses/mit-license.php}
 * @see       ConverterInterface
 */
class PgEntity implements ConverterInterface
{
    protected $row_structure;
    protected $identity_mapper;
    protected $flexible_entity_class;


    /**
     * Constructor.
     *
     * @access public
     * @param                $flexible_entity_class
     * @param RowStructure   $structure
     * @param IdentityMapper $identity_mapper
     */
    public function __construct(
        $flexible_entity_class,
        RowStructure $structure,
        IdentityMapper $identity_mapper = null
    ) {
        $this->flexible_entity_class    = $flexible_entity_class;
        $this->row_structure            = $structure;
        $this->identity_mapper          = $identity_mapper === null
            ? new IdentityMapper()
            : $identity_mapper
            ;
    }

    /**
     * fromPg
     *
     * Embeddable entities are converted here.
     *
     * @see ConverterInterface
     */
    public function fromPg($data, $type, Session $session)
    {
        if (empty($data)) {
            return null;
        }

        $data = trim($data, '()');

        if ($type instanceof Projection) {
            $projection = $type;
        } else {
            $projection = new Projection(
                $this->flexible_entity_class,
                $this->row_structure->getDefinition()
            );
        }

        $entity = (new HydrationPlan(
            $projection,
            $session
        ))->hydrate($this->transformData($data, $projection));

        return $this->cacheEntity($entity);
    }

    /**
     * transformData
     *
     * Split data into an array prefixed with field names.
     *
     * @access private
     * @param  string       $data
     * @param  Projection   $projection
     * @return array
     */
    private function transformData($data, Projection $projection)
    {
        $values         = str_getcsv($data);
        $definition     = $projection->getFieldNames();
        $out_values     = [];
        $values_count   = count($values);

        for ($index = 0; $index < $values_count; $index++) {
            $out_values[$definition[$index]] = preg_match(':^{.*}$:', $values[$index])
                ? stripcslashes($values[$index])
                : $values[$index]
                ;
        }

        return $out_values;
    }

    /**
     * cacheEntity
     *
     * Check entity against the cache.
     *
     * @access public
     * @param  FlexibleEntityInterface   $entity
     * @return FlexibleEntityInterface
     */
    public function cacheEntity(FlexibleEntityInterface $entity)
    {
        return $this
            ->identity_mapper
            ->fetch($entity, $this->row_structure->getPrimaryKey())
            ;
    }

    /**
     * toPg
     *
     * @see ConverterInterface
     */
    public function toPg($data, $type, Session $session)
    {
        if ($data === null) {
            return sprintf("NULL::%s", $type);
        }

        $fields = $this->getFields($data);
        $hydration_plan = $this->createHydrationPlan($session);

        return sprintf(
            "row(%s)::%s",
            join(',', $hydration_plan->dry($fields)),
            $type
        );
    }

    /**
     * createHydrationPlan
     *
     * Create a new hydration plan.
     *
     * @access protected
     * @param  Session          $session
     * @return HydrationPlan
     */
    protected function createHydrationPlan(Session $session)
    {
        return new HydrationPlan(
            new Projection($this->flexible_entity_class, $this->row_structure->getDefinition()),
            $session
        );
    }

    /**
     * getFields
     *
     * Return the fields array.
     *
     * @access protected
     * @param mixed $data
     * @return array
     */
    protected function getFields($data)
    {
        if (is_array($data)) {
            $fields = $data;
        } else {
            $this->checkData($data);
            $fields = $data->fields();
        }

        return $fields;
    }

    /**
     * checkData
     *
     * Check if the given data is the right entity.
     *
     * @access protected
     * @param  mixed        $data
     * @throws  ConverterException
     * @return PgEntity     $this
     */
    protected function checkData($data)
    {
        if (!$data instanceof $this->flexible_entity_class) {
            throw new ConverterException(
                sprintf(
                    "This converter only knows how to convert entities of type '%s' ('%s' given).",
                    $this->flexible_entity_class,
                    get_class($data)
                )
            );
        }

        return $this;
    }

    /**
     * toPgStandardFormat
     *
     * @see ConverterInterface
     */
    public function toPgStandardFormat($data, $type, Session $session)
    {
        if ($data === null) {
            return null;
        }

        $fields = $this->getFields($data);

        return
            sprintf("(%s)",
                join(',', array_map(function ($val) {
                    if ($val === null) {
                        return '';
                    } elseif ($val === '') {
                        return '""';
                    } elseif (preg_match('/[,\s]/', $val)) {
                        return sprintf('"%s"', str_replace('"', '""', $val));
                    } else {
                        return $val;
                    }
                }, $this->createHydrationPlan($session)->freeze($fields)
                ))
            );
    }
}


1			<?php
2			/*
3			* This file is part of the PommProject/ModelManager package.
4			*
5			* (c) 2014 - 2015 Grégoire HUBERT <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace PommProject\ModelManager\Converter;
11
12			use PommProject\Foundation\Converter\ConverterInterface;
13			use PommProject\Foundation\Exception\ConverterException;
14			use PommProject\Foundation\Session\Session;
15			use PommProject\ModelManager\Model\FlexibleEntity\FlexibleEntityInterface;
16			use PommProject\ModelManager\Model\HydrationPlan;
17			use PommProject\ModelManager\Model\IdentityMapper;
18			use PommProject\ModelManager\Model\Projection;
19			use PommProject\ModelManager\Model\RowStructure;
20
21			/**
22			* PgEntity
23			*
24			* Entity converter.
25			* It handles row types and composite types.
26			*
27			* @package ModelManager
28			* @copyright 2014 - 2015 Grégoire HUBERT
29			* @author Grégoire HUBERT
30			* @license X11 {@link http://opensource.org/licenses/mit-license.php}
31			* @see ConverterInterface
32			*/
33			class PgEntity implements ConverterInterface
34			{
35			protected $row_structure;
36			protected $identity_mapper;
37			protected $flexible_entity_class;
38
39
40			/**
41			* Constructor.
42			*
43			* @access public
44			* @param $flexible_entity_class
45			* @param RowStructure $structure
46			* @param IdentityMapper $identity_mapper
47			*/
48			public function __construct(
49			$flexible_entity_class,
50			RowStructure $structure,
51			IdentityMapper $identity_mapper = null
52			) {
53			$this->flexible_entity_class = $flexible_entity_class;
54			$this->row_structure = $structure;
55			$this->identity_mapper = $identity_mapper === null
56			? new IdentityMapper()
57			: $identity_mapper
58			;
59			}
60
61			/**
62			* fromPg
63			*
64			* Embeddable entities are converted here.
65			*
66			* @see ConverterInterface
67			*/
68			public function fromPg($data, $type, Session $session)
69			{
70			if (empty($data)) {
71			return null;
72			}
73
74			$data = trim($data, '()');
75
76			if ($type instanceof Projection) {
77			$projection = $type;
78			} else {
79			$projection = new Projection(
80			$this->flexible_entity_class,
81			$this->row_structure->getDefinition()
82			);
83			}
84
85			$entity = (new HydrationPlan(
86			$projection,
87			$session
88			))->hydrate($this->transformData($data, $projection));
89
90			return $this->cacheEntity($entity);
91			}
92
93			/**
94			* transformData
95			*
96			* Split data into an array prefixed with field names.
97			*
98			* @access private
99			* @param string $data
100			* @param Projection $projection
101			* @return array
102			*/
103			private function transformData($data, Projection $projection)
104			{
105			$values = str_getcsv($data);
106			$definition = $projection->getFieldNames();
107			$out_values = [];
108			$values_count = count($values);
109
110			for ($index = 0; $index < $values_count; $index++) {
111			$out_values[$definition[$index]] = preg_match(':^{.*}$:', $values[$index])
112			? stripcslashes($values[$index])
113			: $values[$index]
114			;
115			}
116
117			return $out_values;
118			}
119
120			/**
121			* cacheEntity
122			*
123			* Check entity against the cache.
124			*
125			* @access public
126			* @param FlexibleEntityInterface $entity
127			* @return FlexibleEntityInterface
128			*/
129			public function cacheEntity(FlexibleEntityInterface $entity)
130			{
131			return $this
132			->identity_mapper
133			->fetch($entity, $this->row_structure->getPrimaryKey())
134			;
135			}
136
137			/**
138			* toPg
139			*
140			* @see ConverterInterface
141			*/
142			public function toPg($data, $type, Session $session)
143			{
144			if ($data === null) {
145			return sprintf("NULL::%s", $type);
146			}
147
148			$fields = $this->getFields($data);
149			$hydration_plan = $this->createHydrationPlan($session);
150
151			return sprintf(
152			"row(%s)::%s",
153			join(',', $hydration_plan->dry($fields)),
154			$type
155			);
156			}
157
158			/**
159			* createHydrationPlan
160			*
161			* Create a new hydration plan.
162			*
163			* @access protected
164			* @param Session $session
165			* @return HydrationPlan
166			*/
167			protected function createHydrationPlan(Session $session)
168			{
169			return new HydrationPlan(
170			new Projection($this->flexible_entity_class, $this->row_structure->getDefinition()),
171			$session
172			);
173			}
174
175			/**
176			* getFields
177			*
178			* Return the fields array.
179			*
180			* @access protected
181			* @param mixed $data
182			* @return array
183			*/
184			protected function getFields($data)
185			{
186			if (is_array($data)) {
187			$fields = $data;
188			} else {
189			$this->checkData($data);
190			$fields = $data->fields();
191			}
192
193			return $fields;
194			}
195
196			/**
197			* checkData
198			*
199			* Check if the given data is the right entity.
200			*
201			* @access protected
202			* @param mixed $data
203			* @throws ConverterException
204			* @return PgEntity $this
205			*/
206			protected function checkData($data)
207			{
208			if (!$data instanceof $this->flexible_entity_class) {
209			throw new ConverterException(
210			sprintf(
211			"This converter only knows how to convert entities of type '%s' ('%s' given).",
212			$this->flexible_entity_class,
213			get_class($data)
214			)
215			);
216			}
217
218			return $this;
219			}
220
221			/**
222			* toPgStandardFormat
223			*
224			* @see ConverterInterface
225			*/
226			public function toPgStandardFormat($data, $type, Session $session)
227			{
228			if ($data === null) {
229			return null;
230			}
231
232			$fields = $this->getFields($data);
233
234			return
235			sprintf("(%s)",
236			join(',', array_map(function ($val) {
237			if ($val === null) {
238			return '';
239			} elseif ($val === '') {
240			return '""';
241			} elseif (preg_match('/[,\s]/', $val)) {
242			return sprintf('"%s"', str_replace('"', '""', $val));
243			} else {
244			return $val;
245			}
246			}, $this->createHydrationPlan($session)->freeze($fields)
247			))
248			);
249			}
250			}
251

pomm-project / ModelManager

Pull Request — 2.0 (#62)

PgEntity::fromPg() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like