ynloultratech /
graphql-bundle
| Total Complexity | 57 |
| Total Lines | 417 |
| Duplicated Lines | 0 % |
| Coverage | 0% |
| Changes | 4 | ||
| Bugs | 0 | Features | 0 |
Complex classes like PaginationDefinitionPlugin often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use PaginationDefinitionPlugin, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 42 | class PaginationDefinitionPlugin extends AbstractDefinitionPlugin implements BackwardCompatibilityAwareInterface |
||
| 43 | { |
||
| 44 | use BackwardCompatibilityAwareTrait; |
||
| 45 | |||
| 46 | public const ONE_TO_MANY = 'ONE_TO_MANY'; |
||
| 47 | public const MANY_TO_MANY = 'MANY_TO_MANY'; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * @var FilterFactory |
||
| 51 | */ |
||
| 52 | protected $filterFactory; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * @var int |
||
| 56 | */ |
||
| 57 | protected $limit; |
||
| 58 | |||
| 59 | /** |
||
| 60 | * PaginationDefinitionPlugin constructor. |
||
| 61 | * |
||
| 62 | * @param FilterFactory $filterFactory |
||
| 63 | * @param array $config |
||
| 64 | */ |
||
| 65 | public function __construct(FilterFactory $filterFactory, array $config = []) |
||
| 66 | { |
||
| 67 | $this->filterFactory = $filterFactory; |
||
| 68 | $this->limit = $config['limit'] ?? 100; |
||
| 69 | } |
||
| 70 | |||
| 71 | /** |
||
| 72 | * {@inheritDoc} |
||
| 73 | */ |
||
| 74 | public function buildConfig(ArrayNodeDefinition $root): void |
||
| 75 | { |
||
| 76 | $config = $root |
||
| 77 | ->info('Enable pagination in queries or sub-fields') |
||
| 78 | ->canBeEnabled() |
||
| 79 | ->children(); |
||
| 80 | |||
| 81 | /** @var NodeBuilder $rootNode */ |
||
| 82 | $config->scalarNode('target') |
||
| 83 | ->info('Target node to properly paginate. If is possible will be auto-resolved using naming conventions') |
||
| 84 | ->isRequired(); |
||
| 85 | $config->variableNode('filters') |
||
| 86 | ->info('Filters configuration'); |
||
| 87 | $config->variableNode('order_by'); |
||
| 88 | $config->variableNode('search_fields'); |
||
| 89 | $config->integerNode('limit')->info('Max number of records allowed for first & last')->defaultValue($this->limit); |
||
| 90 | $config->scalarNode('parent_field') |
||
| 91 | ->info('When is used in sub-fields should be the field to filter by parent instance'); |
||
| 92 | $config->enumNode('parent_relation') |
||
| 93 | ->info('When is used in sub-fields should be the type of relation with the parent field') |
||
| 94 | ->defaultValue(self::ONE_TO_MANY) |
||
| 95 | ->values([self::ONE_TO_MANY, self::MANY_TO_MANY]); |
||
| 96 | } |
||
| 97 | |||
| 98 | /** |
||
| 99 | * {@inheritDoc} |
||
| 100 | */ |
||
| 101 | public function normalizeConfig(DefinitionInterface $definition, $config): array |
||
| 102 | { |
||
| 103 | if (true === $config && $definition instanceof ExecutableDefinitionInterface) { |
||
| 104 | $config = []; |
||
| 105 | } |
||
| 106 | |||
| 107 | if (\is_array($config) && !isset($config['target'])) { |
||
| 108 | $config['target'] = $definition->getType(); |
||
|
Bug
introduced
by
|
|||
| 109 | } |
||
| 110 | |||
| 111 | if (false === $config) { |
||
| 112 | $config = []; |
||
| 113 | } |
||
| 114 | |||
| 115 | return $config; |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * {@inheritdoc} |
||
| 120 | */ |
||
| 121 | public function configure(DefinitionInterface $definition, Endpoint $endpoint, array $config): void |
||
| 122 | { |
||
| 123 | if (!$config) { |
||
| 124 | return; |
||
| 125 | } |
||
| 126 | |||
| 127 | if (!$definition instanceof QueryDefinition && !$definition instanceof FieldDefinition) { |
||
| 128 | return; |
||
| 129 | } |
||
| 130 | |||
| 131 | $target = null; |
||
| 132 | if ($definition instanceof FieldDefinition) { |
||
| 133 | $target = $definition->getType(); |
||
| 134 | // only apply pagination to inherited fields |
||
| 135 | // if all interfaces has pagination enabled |
||
| 136 | if ($definition->getInheritedFrom()) { |
||
| 137 | foreach ($definition->getInheritedFrom() as $inheritedType) { |
||
| 138 | /** @var InterfaceDefinition $inheritedDefinition */ |
||
| 139 | $inheritedDefinition = $endpoint->getType($inheritedType); |
||
| 140 | if (!$inheritedDefinition->getField($definition->getName())->hasMeta('pagination')) { |
||
| 141 | return; |
||
| 142 | } |
||
| 143 | } |
||
| 144 | } |
||
| 145 | } |
||
| 146 | |||
| 147 | $search = new ArgumentDefinition(); |
||
| 148 | $search->setName('search'); |
||
| 149 | $search->setType('string'); |
||
| 150 | $search->setNonNull(false); |
||
| 151 | $search->setDescription('Search in current list by given string'); |
||
| 152 | $definition->addArgument($search); |
||
| 153 | |||
| 154 | $target = $config['target'] ?? $target; |
||
| 155 | if ($endpoint->hasTypeForClass($target)) { |
||
| 156 | $target = $endpoint->getTypeForClass($target); |
||
| 157 | } |
||
| 158 | $targetNode = $endpoint->getType($target); |
||
| 159 | |||
| 160 | $this->addPaginationArguments($definition); |
||
| 161 | $this->createOrderBy($endpoint, $definition, $targetNode); |
||
| 162 | |||
| 163 | $connection = $this->createConnection($endpoint, $targetNode); |
||
| 164 | $definition->setType($connection->getName()); |
||
| 165 | $definition->setList(false); |
||
| 166 | $definition->setNode($target); |
||
| 167 | $definition->setMeta('pagination', $config); |
||
| 168 | |||
| 169 | if (!$definition->getResolver()) { |
||
| 170 | $definition->setResolver(AllNodesWithPagination::class); |
||
| 171 | } |
||
| 172 | |||
| 173 | $this->filterFactory->build($definition, $targetNode, $endpoint); |
||
| 174 | |||
| 175 | //deprecated, keep for BC with v1 |
||
| 176 | if ($this->bcConfig['filters'] ?? false) { |
||
| 177 | $this->addFilters($definition, $target, $endpoint); |
||
| 178 | } |
||
| 179 | } |
||
| 180 | |||
| 181 | /** |
||
| 182 | * @param Endpoint $endpoint |
||
| 183 | * @param DefinitionInterface $node |
||
| 184 | * |
||
| 185 | * @return ObjectDefinition |
||
| 186 | */ |
||
| 187 | private function createConnection(Endpoint $endpoint, DefinitionInterface $node): ObjectDefinition |
||
| 241 | } |
||
| 242 | |||
| 243 | /** |
||
| 244 | * @param Endpoint $endpoint |
||
| 245 | * @param ExecutableDefinitionInterface $query |
||
| 246 | * @param FieldsAwareDefinitionInterface $node |
||
| 247 | */ |
||
| 248 | private function createOrderBy(Endpoint $endpoint, ExecutableDefinitionInterface $query, FieldsAwareDefinitionInterface $node) |
||
| 249 | { |
||
| 250 | /** @var InputObjectDefinition $orderBy */ |
||
| 251 | $orderBy = unserialize(serialize($endpoint->getType(OrderBy::class)), ['allowed_classes' => true]); //clone recursively |
||
| 252 | $orderBy->setName("{$node->getName()}OrderBy"); |
||
| 253 | |||
| 254 | if (!$endpoint->hasType($orderBy->getName())) { |
||
| 255 | $orderByFields = new EnumDefinition(); |
||
| 256 | $orderByFields->setName("{$node->getName()}OrderByField"); |
||
| 257 | $options = $query->getMeta('pagination')['order_by'] ?? ['*']; |
||
| 258 | $options = FieldOptionsHelper::normalize($options); |
||
| 259 | |||
| 260 | foreach ($node->getFields() as $field) { |
||
| 261 | if (!FieldOptionsHelper::isEnabled($options, $field->getName())) { |
||
| 262 | continue; |
||
| 263 | } |
||
| 264 | |||
| 265 | //ignore if non related to entity property |
||
| 266 | if ($field->getOriginType() !== \ReflectionProperty::class) { |
||
| 267 | continue; |
||
| 268 | } |
||
| 269 | |||
| 270 | //ignore if is a list |
||
| 271 | if ($field->isList()) { |
||
| 272 | continue; |
||
| 273 | } |
||
| 274 | |||
| 275 | //ignore if is related to other object |
||
| 276 | if ($endpoint->hasType($field->getType()) && $endpoint->getType($field->getType()) instanceof FieldsAwareDefinitionInterface) { |
||
| 277 | continue; |
||
| 278 | } |
||
| 279 | |||
| 280 | $definition = new EnumValueDefinition($field->getName()); |
||
| 281 | $definition->setMeta('resolver', OrderBySimpleField::class); |
||
| 282 | $definition->setMeta('field', $field->getName()); |
||
| 283 | |||
| 284 | $orderByFields->addValue($definition); |
||
| 285 | } |
||
| 286 | |||
| 287 | //configure custom orderBy and support for children, like "parentName" => parent.name |
||
| 288 | foreach ($options as $fieldName => $config) { |
||
| 289 | if ('*' === $fieldName || '*' === $config || !FieldOptionsHelper::isEnabled($options, $fieldName)) { |
||
| 290 | continue; |
||
| 291 | } |
||
| 292 | |||
| 293 | if (array_key_exists($fieldName, $orderByFields->getValues())) { |
||
| 294 | continue; |
||
| 295 | } |
||
| 296 | |||
| 297 | $field = $fieldName; |
||
| 298 | $resolver = OrderBySimpleField::class; |
||
| 299 | if (strpos($config, '.') !== false) { |
||
| 300 | $resolver = OrderByRelatedField::class; |
||
| 301 | $field = $config; |
||
| 302 | } elseif (is_string($config)) { |
||
| 303 | $field = $config; |
||
| 304 | } |
||
| 305 | |||
| 306 | if (class_exists($config) && is_a($config, OrderByInterface::class, true)) { |
||
| 307 | $resolver = $config; |
||
| 308 | $field = $fieldName; |
||
| 309 | } |
||
| 310 | |||
| 311 | $definition = new EnumValueDefinition($fieldName); |
||
| 312 | $definition->setMeta('resolver', $resolver); |
||
| 313 | $definition->setMeta('field', $field); |
||
| 314 | |||
| 315 | $orderByFields->addValue($definition); |
||
| 316 | } |
||
| 317 | |||
| 318 | if ($orderByFields->getValues()) { |
||
| 319 | $orderBy->getField('field')->setType($orderByFields->getName()); |
||
| 320 | $endpoint->addType($orderByFields); |
||
| 321 | $endpoint->addType($orderBy); |
||
| 322 | } else { |
||
| 323 | return; |
||
| 324 | } |
||
| 325 | } else { |
||
| 326 | $orderBy = $endpoint->getType($orderBy->getName()); |
||
| 327 | } |
||
| 328 | |||
| 329 | $arg = new ArgumentDefinition(); |
||
| 330 | $arg->setName('order'); |
||
| 331 | $arg->setType($orderBy->getName()); |
||
| 332 | $arg->setNonNull(false); |
||
| 333 | $arg->setList(true); |
||
| 334 | $arg->setDescription('Ordering options for this list.'); |
||
| 335 | $query->addArgument($arg); |
||
| 336 | |||
| 337 | //to keep BC |
||
| 338 | if ($this->bcConfig['orderBy'] ?? false) { |
||
| 339 | $arg = new ArgumentDefinition(); |
||
| 340 | $arg->setName('orderBy'); |
||
| 341 | $arg->setType(OrderBy::class); |
||
| 342 | $arg->setNonNull(false); |
||
| 343 | $arg->setList(true); |
||
| 344 | $deprecateMessage = \is_string($this->bcConfig['orderBy']) ? $this->bcConfig['orderBy'] : '**DEPRECATED** use `order` instead.'; |
||
| 345 | $arg->setDescription($deprecateMessage); |
||
| 346 | $query->addArgument($arg); |
||
| 347 | } |
||
| 348 | } |
||
| 349 | |||
| 350 | /** |
||
| 351 | * @param ExecutableDefinitionInterface $definition |
||
| 352 | */ |
||
| 353 | private function addPaginationArguments(ExecutableDefinitionInterface $definition): void |
||
| 389 | } |
||
| 390 | |||
| 391 | /** |
||
| 392 | * @param ExecutableDefinitionInterface $definition |
||
| 393 | * @param string $targetType |
||
| 394 | * @param Endpoint $endpoint |
||
| 395 | * |
||
| 396 | * @throws \ReflectionException |
||
| 397 | * |
||
| 398 | * @deprecated since v1.2, should use `where` instead |
||
| 399 | */ |
||
| 400 | private function addFilters(ExecutableDefinitionInterface $definition, string $targetType, Endpoint $endpoint): void |
||
| 461 |
Loading history...