BZIon\Form\Transformer\AdvancedModelTransformer

Complexity

Total Complexity

25

Size/Duplication

Total Lines	168
Duplicated Lines	7.14 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

43.75%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
B	transform()	0	28	5
A	invalidModel()	0	10	2
A	getModelFromName()	0	14	4
C	transformJSON()	12	64	12

<?php

namespace BZIon\Form\Transformer;

use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Exception\TransformationFailedException;

abstract class AdvancedModelTransformer implements DataTransformerInterface
{
    /**
     * @var string[]
     */
    protected $types;

    /**
     * @param string[] $type     The types of the models

There is no parameter named $type. Was it maybe removed?

     */
    public function __construct(array $types)
    {
        if (empty($types)) {
            throw new \Exception("No type has been specified");
        }

        $this->types = $types;
    }

    /**
     * Transforms an object (model) to the form representation
     *
     * @param  Model|null $model

There is no parameter named $model. Did you maybe mean $models?

     * @return array
     */
    public function transform($models)
    {
        if ($models === null) {
            $models = array();
        } elseif (!is_array($models)) {
            $models = array($models);
        }

        $data = $json = array();
        foreach ($models as $model) {
            $data[$model->getType()][] = $model->getName();
            $json[] = array(
                'id'   => $model->getID(),
                'name' => $model->getName(),
                'type' => ucfirst($model->getType())
            );
        }

        foreach ($data as $type => &$value) {
            $value = implode(', ', $value);
        }

        $data['ids'] = json_encode(array(
            'data' => $json
        ));

        return $data;
    }

    /**
     * Get an invalid model of an acceptable type
     *
     * @param  string|null $type The type of the model, or null to select one of
     *                           the specified types
     * @return \Model
     */
    protected function invalidModel($type = null)
    {
        if ($type === null) {
            $type = reset($this->types); // Get the first value of $this->types
        }

        $type = ucfirst($type);

        return call_user_func(array($type, 'invalid'));
    }

    /**
     * Get a model from its name
     * @param  string     $name The name of the model
     * @param  string     $type The type of the model in lower case
     * @return NamedModel|null  The model or null if no name was specified
     */
    protected function getModelFromName($name, $type)
    {
        if ($name === '') {
            return null;
        }

        if ($type === 'player') {
            return \Player::getFromUsername($name);
        } elseif ($type === 'team') {
            return \Team::getFromName($name);
        } else {
            throw new \InvalidArgumentException('Unsupported model type');
        }
    }

    /**
     * Transform JSON data provided by javascript to a list of Models
     *
     * @param  string $json The JSON provided to us by javascript, containing

There is no parameter named $json. Was it maybe removed?

     *                      a list of Model IDs and types
     * @param  array  $include An array of Models of each type that will be
     *                         included in the final result
     * @return bool|Model[] A list of models, or false if the data was not
     *                         provided by javascript as JSON
     */
    protected function transformJSON(&$data, $include = array())
    {
        $json = json_decode($data['ids'], true);

        if (!isset($json['modified']) || $json['modified'] !== true) {
            // The JSON data was not modified; we can proceed to check input
            // from other sources
            return false;
        }

        // Array to store IDs for quick access so we can be sure that no
        // duplicates are saved
        $ids = array();

        $models = array();

        foreach ($include as $type => $includedModels) {
            foreach ($includedModels as $model) {
                $ids[$type][$model->getID()] = true; // Prevent duplication
                $models[] = $model;
            }
        }

        foreach ($json['data'] as $key => $object) {
            if ($key === 'modified') {
                // This is just an object that lets us know javascript provided
                // data, we should ignore it
                continue;
            }

            if (!isset($object['id']) || !isset($object['type'])) {
                throw new TransformationFailedException(
                    "Invalid model provided"
                );
            }

            $type = strtolower($object['type']);

            // Sanity check so that the user can't generate arbitrary classes
            if (!in_array($type, $this->types)) {
                throw new TransformationFailedException(
                    "Objects of type \"{$object['type']}\" are not supported"
                );
            }

            $class = ucfirst($object['type']);
            $model = $class::get($object['id']);

            if ($model->isDeleted()) {

This code seems to be duplicated across your project.

                // Show an error message if the model provided by javascript is
                // invalid - we don't let the validator handle this error, so
                // that the user doesn't see a vague warning
                throw new TransformationFailedException(
                    "Invalid model ID provided"
                );
            } elseif (!isset($ids[$type][$model->getID()])) {
                // The model passed the duplication check
                $models[] = $model;
                $ids[$type][$model->getID()] = true;
            }
        }

        return $models;
    }
}