reginaldojunior /
winners
Complex classes like PaginatorComponent 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 PaginatorComponent, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 71 | class PaginatorComponent extends Component { |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Pagination settings. These settings control pagination at a general level. |
||
| 75 | * You can also define sub arrays for pagination settings for specific models. |
||
| 76 | * |
||
| 77 | * - `maxLimit` The maximum limit users can choose to view. Defaults to 100 |
||
| 78 | * - `limit` The initial number of items per page. Defaults to 20. |
||
| 79 | * - `page` The starting page, defaults to 1. |
||
| 80 | * - `paramType` What type of parameters you want pagination to use? |
||
| 81 | * - `named` Use named parameters / routed parameters. |
||
| 82 | * - `querystring` Use query string parameters. |
||
| 83 | * |
||
| 84 | * @var array |
||
| 85 | */ |
||
| 86 | public $settings = array( |
||
| 87 | 'page' => 1, |
||
| 88 | 'limit' => 20, |
||
| 89 | 'maxLimit' => 100, |
||
| 90 | 'paramType' => 'named' |
||
| 91 | ); |
||
| 92 | |||
| 93 | /** |
||
| 94 | * A list of parameters users are allowed to set using request parameters. Modifying |
||
| 95 | * this list will allow users to have more influence over pagination, |
||
| 96 | * be careful with what you permit. |
||
| 97 | * |
||
| 98 | * @var array |
||
| 99 | */ |
||
| 100 | public $whitelist = array( |
||
| 101 | 'limit', 'sort', 'page', 'direction' |
||
| 102 | ); |
||
| 103 | |||
| 104 | /** |
||
| 105 | * Constructor |
||
| 106 | * |
||
| 107 | * @param ComponentCollection $collection A ComponentCollection this component can use to lazy load its components |
||
| 108 | * @param array $settings Array of configuration settings. |
||
| 109 | */ |
||
| 110 | public function __construct(ComponentCollection $collection, $settings = array()) { |
||
| 115 | |||
| 116 | /** |
||
| 117 | * Handles automatic pagination of model records. |
||
| 118 | * |
||
| 119 | * @param Model|string $object Model to paginate (e.g: model instance, or 'Model', or 'Model.InnerModel') |
||
| 120 | * @param string|array $scope Additional find conditions to use while paginating |
||
| 121 | * @param array $whitelist List of allowed fields for ordering. This allows you to prevent ordering |
||
| 122 | * on non-indexed, or undesirable columns. See PaginatorComponent::validateSort() for additional details |
||
| 123 | * on how the whitelisting and sort field validation works. |
||
| 124 | * @return array Model query results |
||
| 125 | * @throws MissingModelException |
||
| 126 | * @throws NotFoundException |
||
| 127 | */ |
||
| 128 | public function paginate($object = null, $scope = array(), $whitelist = array()) { |
||
| 249 | |||
| 250 | /** |
||
| 251 | * Get the object pagination will occur on. |
||
| 252 | * |
||
| 253 | * @param string|Model $object The object you are looking for. |
||
| 254 | * @return mixed The model object to paginate on. |
||
| 255 | */ |
||
| 256 | protected function _getObject($object) { |
||
| 293 | |||
| 294 | /** |
||
| 295 | * Merges the various options that Pagination uses. |
||
| 296 | * Pulls settings together from the following places: |
||
| 297 | * |
||
| 298 | * - General pagination settings |
||
| 299 | * - Model specific settings. |
||
| 300 | * - Request parameters |
||
| 301 | * |
||
| 302 | * The result of this method is the aggregate of all the option sets combined together. You can change |
||
| 303 | * PaginatorComponent::$whitelist to modify which options/values can be set using request parameters. |
||
| 304 | * |
||
| 305 | * @param string $alias Model alias being paginated, if the general settings has a key with this value |
||
| 306 | * that key's settings will be used for pagination instead of the general ones. |
||
| 307 | * @return array Array of merged options. |
||
| 308 | */ |
||
| 309 | public function mergeOptions($alias) { |
||
| 322 | |||
| 323 | /** |
||
| 324 | * Get the default settings for a $model. If there are no settings for a specific model, the general settings |
||
| 325 | * will be used. |
||
| 326 | * |
||
| 327 | * @param string $alias Model name to get default settings for. |
||
| 328 | * @return array An array of pagination defaults for a model, or the general settings. |
||
| 329 | */ |
||
| 330 | public function getDefaults($alias) { |
||
| 345 | |||
| 346 | /** |
||
| 347 | * Validate that the desired sorting can be performed on the $object. Only fields or |
||
| 348 | * virtualFields can be sorted on. The direction param will also be sanitized. Lastly |
||
| 349 | * sort + direction keys will be converted into the model friendly order key. |
||
| 350 | * |
||
| 351 | * You can use the whitelist parameter to control which columns/fields are available for sorting. |
||
| 352 | * This helps prevent users from ordering large result sets on un-indexed values. |
||
| 353 | * |
||
| 354 | * Any columns listed in the sort whitelist will be implicitly trusted. You can use this to sort |
||
| 355 | * on synthetic columns, or columns added in custom find operations that may not exist in the schema. |
||
| 356 | * |
||
| 357 | * @param Model $object The model being paginated. |
||
| 358 | * @param array $options The pagination options being used for this request. |
||
| 359 | * @param array $whitelist The list of columns that can be used for sorting. If empty all keys are allowed. |
||
| 360 | * @return array An array of options with sort + direction removed and replaced with order if possible. |
||
| 361 | */ |
||
| 362 | public function validateSort(Model $object, array $options, array $whitelist = array()) { |
||
| 410 | |||
| 411 | /** |
||
| 412 | * Check the limit parameter and ensure its within the maxLimit bounds. |
||
| 413 | * |
||
| 414 | * @param array $options An array of options with a limit key to be checked. |
||
| 415 | * @return array An array of options for pagination |
||
| 416 | */ |
||
| 417 | public function checkLimit(array $options) { |
||
| 425 | |||
| 426 | } |
||
| 427 |
Loading history...
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.