|
| 1 | +<?php |
| 2 | +namespace FractalTransformerView\View; |
| 3 | + |
| 4 | +use Cake\Event\EventManager; |
| 5 | +use Cake\Network\Request; |
| 6 | +use Cake\Network\Response; |
| 7 | +use FractalTransformerView\Serializer\ArraySerializer; |
| 8 | +use Cake\Core\Configure; |
| 9 | +use Cake\Datasource\EntityInterface; |
| 10 | +use Cake\ORM\Query; |
| 11 | +use Cake\ORM\ResultSet; |
| 12 | +use Cake\Utility\Hash; |
| 13 | +use Cake\View\JsonView; |
| 14 | +use Exception; |
| 15 | +use League\Fractal\Manager; |
| 16 | +use League\Fractal\Resource\Collection; |
| 17 | +use League\Fractal\Resource\Item; |
| 18 | +use League\Fractal\TransformerAbstract; |
| 19 | + |
| 20 | +/** |
| 21 | + * FractalTransformerView class |
| 22 | + */ |
| 23 | +class FractalTransformerView extends JsonView |
| 24 | +{ |
| 25 | + /** |
| 26 | + * Constructor |
| 27 | + * |
| 28 | + * @param \Cake\Network\Request $request Request instance. |
| 29 | + * @param \Cake\Network\Response $response Response instance. |
| 30 | + * @param \Cake\Event\EventManager $eventManager EventManager instance. |
| 31 | + * @param array $viewOptions An array of view options |
| 32 | + */ |
| 33 | + public function __construct( |
| 34 | + Request $request = null, |
| 35 | + Response $response = null, |
| 36 | + EventManager $eventManager = null, |
| 37 | + array $viewOptions = [] |
| 38 | + ) { |
| 39 | + parent::__construct($request, $response, $eventManager, $viewOptions); |
| 40 | + |
| 41 | + $this->_specialVars[] = '_transform'; |
| 42 | + } |
| 43 | + |
| 44 | + /** |
| 45 | + * Get transform class name for given var by figuring out which entity it belongs to. Return FALSE otherwise |
| 46 | + * |
| 47 | + * @param $var |
| 48 | + * @return bool|string |
| 49 | + */ |
| 50 | + protected function getTransformerClass($var) |
| 51 | + { |
| 52 | + $entity = null; |
| 53 | + if ($var instanceof Query) { |
| 54 | + $entity = $var->repository()->newEntity(); |
| 55 | + } elseif ($var instanceof ResultSet) { |
| 56 | + $entity = $var->first(); |
| 57 | + } elseif ($var instanceof EntityInterface) { |
| 58 | + $entity = $var; |
| 59 | + } elseif (is_array($var)) { |
| 60 | + $entity = reset($var); |
| 61 | + } |
| 62 | + |
| 63 | + if (!$entity || !is_object($entity)) { |
| 64 | + return false; |
| 65 | + } |
| 66 | + |
| 67 | + $entityClass = get_class($entity); |
| 68 | + $transformerClass = str_replace('\\Model\\Entity\\', '\\Model\\Transformer\\', $entityClass) . 'Transformer'; |
| 69 | + |
| 70 | + if (!class_exists($transformerClass)) { |
| 71 | + return false; |
| 72 | + } |
| 73 | + |
| 74 | + return $transformerClass; |
| 75 | + } |
| 76 | + |
| 77 | + /** |
| 78 | + * Get transformer for given var |
| 79 | + * |
| 80 | + * @param $var |
| 81 | + * @param bool $varName |
| 82 | + * @return bool |
| 83 | + * @throws Exception |
| 84 | + */ |
| 85 | + protected function getTransformer($var, $varName = false) |
| 86 | + { |
| 87 | + $_transform = $this->get('_transform'); |
| 88 | + $transformerClass = $varName |
| 89 | + ? Hash::get((array)$_transform, $varName) |
| 90 | + : $_transform; |
| 91 | + |
| 92 | + if (is_null($transformerClass)) { |
| 93 | + $transformerClass = $this->getTransformerClass($var); |
| 94 | + } |
| 95 | + |
| 96 | + if ($transformerClass === false) { |
| 97 | + return false; |
| 98 | + } |
| 99 | + |
| 100 | + if (!class_exists($transformerClass)) { |
| 101 | + throw new Exception(sprintf('Invalid Transformer class: %s', $transformerClass)); |
| 102 | + } |
| 103 | + |
| 104 | + $transformer = new $transformerClass; |
| 105 | + if (!($transformer instanceof TransformerAbstract)) { |
| 106 | + throw new Exception(sprintf('Transformer class not instance of TransformerAbstract: %s', |
| 107 | + $transformerClass)); |
| 108 | + } |
| 109 | + |
| 110 | + return $transformer; |
| 111 | + } |
| 112 | + |
| 113 | + /** |
| 114 | + * Transform var using given manager |
| 115 | + * |
| 116 | + * @param Manager $manager |
| 117 | + * @param $var |
| 118 | + * @param bool $varName |
| 119 | + * @return array |
| 120 | + * @throws Exception |
| 121 | + */ |
| 122 | + protected function transform(Manager $manager, $var, $varName = false) |
| 123 | + { |
| 124 | + if (!$transformer = $this->getTransformer($var, $varName)) { |
| 125 | + return $var; |
| 126 | + } |
| 127 | + |
| 128 | + if (is_array($var) || $var instanceof Query || $var instanceof ResultSet) { |
| 129 | + $resource = new Collection($var, $transformer); |
| 130 | + } elseif ($var instanceof EntityInterface) { |
| 131 | + $resource = new Item($var, $transformer); |
| 132 | + } else { |
| 133 | + throw new Exception('Unserializable variable'); |
| 134 | + } |
| 135 | + |
| 136 | + return $manager->createData($resource)->toArray(); |
| 137 | + } |
| 138 | + |
| 139 | + /** |
| 140 | + * Returns data to be serialized. |
| 141 | + * |
| 142 | + * @param bool $serialize |
| 143 | + * @return array|mixed |
| 144 | + * @throws Exception |
| 145 | + */ |
| 146 | + protected function _dataToSerialize($serialize = true) |
| 147 | + { |
| 148 | + $data = parent::_dataToSerialize($serialize); |
| 149 | + |
| 150 | + $serializer = new ArraySerializer(); |
| 151 | + $manager = new Manager(); |
| 152 | + $manager->setSerializer($serializer); |
| 153 | + |
| 154 | + if (is_array($data)) { |
| 155 | + foreach ($data as $varName => &$var) { |
| 156 | + $var = $this->transform($manager, $var, $varName); |
| 157 | + } |
| 158 | + unset($var); |
| 159 | + } else { |
| 160 | + $data = $this->transform($manager, $data); |
| 161 | + } |
| 162 | + |
| 163 | + return $data; |
| 164 | + } |
| 165 | +} |
0 commit comments