aimeos /
ai-client-jsonapi
| Total Complexity | 41 |
| Total Lines | 453 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Standard 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 Standard, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 23 | class Standard |
||
| 24 | extends \Aimeos\Client\JsonApi\Basket\Base |
||
| 25 | implements \Aimeos\Client\JsonApi\Iface |
||
| 26 | { |
||
| 27 | /** client/jsonapi/basket/address/name |
||
| 28 | * Class name of the used basket/address client implementation |
||
| 29 | * |
||
| 30 | * Each default JSON API client can be replace by an alternative imlementation. |
||
| 31 | * To use this implementation, you have to set the last part of the class |
||
| 32 | * name as configuration value so the client factory knows which class it |
||
| 33 | * has to instantiate. |
||
| 34 | * |
||
| 35 | * For example, if the name of the default class is |
||
| 36 | * |
||
| 37 | * \Aimeos\Client\JsonApi\Basket\Address\Standard |
||
| 38 | * |
||
| 39 | * and you want to replace it with your own version named |
||
| 40 | * |
||
| 41 | * \Aimeos\Client\JsonApi\Basket\Address\Mybasket/address |
||
| 42 | * |
||
| 43 | * then you have to set the this configuration option: |
||
| 44 | * |
||
| 45 | * client/jsonapi/basket/address/name = Mybasket/address |
||
| 46 | * |
||
| 47 | * The value is the last part of your own class name and it's case sensitive, |
||
| 48 | * so take care that the configuration value is exactly named like the last |
||
| 49 | * part of the class name. |
||
| 50 | * |
||
| 51 | * The allowed characters of the class name are A-Z, a-z and 0-9. No other |
||
| 52 | * characters are possible! You should always start the last part of the class |
||
| 53 | * name with an upper case character and continue only with lower case characters |
||
| 54 | * or numbers. Avoid chamel case names like "MyAddress"! |
||
| 55 | * |
||
| 56 | * @param string Last part of the class name |
||
| 57 | * @since 2017.03 |
||
| 58 | * @category Developer |
||
| 59 | */ |
||
| 60 | |||
| 61 | /** client/jsonapi/basket/address/decorators/excludes |
||
| 62 | * Excludes decorators added by the "common" option from the JSON API clients |
||
| 63 | * |
||
| 64 | * Decorators extend the functionality of a class by adding new aspects |
||
| 65 | * (e.g. log what is currently done), executing the methods of the underlying |
||
| 66 | * class only in certain conditions (e.g. only for logged in users) or |
||
| 67 | * modify what is returned to the caller. |
||
| 68 | * |
||
| 69 | * This option allows you to remove a decorator added via |
||
| 70 | * "client/jsonapi/common/decorators/default" before they are wrapped |
||
| 71 | * around the JsonApi client. |
||
| 72 | * |
||
| 73 | * client/jsonapi/decorators/excludes = array( 'decorator1' ) |
||
| 74 | * |
||
| 75 | * This would remove the decorator named "decorator1" from the list of |
||
| 76 | * common decorators ("\Aimeos\Client\JsonApi\Common\Decorator\*") added via |
||
| 77 | * "client/jsonapi/common/decorators/default" for the JSON API client. |
||
| 78 | * |
||
| 79 | * @param array List of decorator names |
||
| 80 | * @since 2017.07 |
||
| 81 | * @category Developer |
||
| 82 | * @see client/jsonapi/common/decorators/default |
||
| 83 | * @see client/jsonapi/basket/address/decorators/global |
||
| 84 | * @see client/jsonapi/basket/address/decorators/local |
||
| 85 | */ |
||
| 86 | |||
| 87 | /** client/jsonapi/basket/address/decorators/global |
||
| 88 | * Adds a list of globally available decorators only to the JsonApi client |
||
| 89 | * |
||
| 90 | * Decorators extend the functionality of a class by adding new aspects |
||
| 91 | * (e.g. log what is currently done), executing the methods of the underlying |
||
| 92 | * class only in certain conditions (e.g. only for logged in users) or |
||
| 93 | * modify what is returned to the caller. |
||
| 94 | * |
||
| 95 | * This option allows you to wrap global decorators |
||
| 96 | * ("\Aimeos\Client\JsonApi\Common\Decorator\*") around the JsonApi |
||
| 97 | * client. |
||
| 98 | * |
||
| 99 | * client/jsonapi/basket/address/decorators/global = array( 'decorator1' ) |
||
| 100 | * |
||
| 101 | * This would add the decorator named "decorator1" defined by |
||
| 102 | * "\Aimeos\Client\JsonApi\Common\Decorator\Decorator1" only to the |
||
| 103 | * "basket" JsonApi client. |
||
| 104 | * |
||
| 105 | * @param array List of decorator names |
||
| 106 | * @since 2017.07 |
||
| 107 | * @category Developer |
||
| 108 | * @see client/jsonapi/common/decorators/default |
||
| 109 | * @see client/jsonapi/basket/address/decorators/excludes |
||
| 110 | * @see client/jsonapi/basket/address/decorators/local |
||
| 111 | */ |
||
| 112 | |||
| 113 | /** client/jsonapi/basket/address/decorators/local |
||
| 114 | * Adds a list of local decorators only to the JsonApi client |
||
| 115 | * |
||
| 116 | * Decorators extend the functionality of a class by adding new aspects |
||
| 117 | * (e.g. log what is currently done), executing the methods of the underlying |
||
| 118 | * class only in certain conditions (e.g. only for logged in users) or |
||
| 119 | * modify what is returned to the caller. |
||
| 120 | * |
||
| 121 | * This option allows you to wrap local decorators |
||
| 122 | * ("\Aimeos\Client\JsonApi\Basket\Address\Decorator\*") around the JsonApi |
||
| 123 | * client. |
||
| 124 | * |
||
| 125 | * client/jsonapi/basket/address/decorators/local = array( 'decorator2' ) |
||
| 126 | * |
||
| 127 | * This would add the decorator named "decorator2" defined by |
||
| 128 | * "\Aimeos\Client\JsonApi\Basket\Address\Decorator\Decorator2" only to the |
||
| 129 | * "basket address" JsonApi client. |
||
| 130 | * |
||
| 131 | * @param array List of decorator names |
||
| 132 | * @since 2017.07 |
||
| 133 | * @category Developer |
||
| 134 | * @see client/jsonapi/common/decorators/default |
||
| 135 | * @see client/jsonapi/basket/address/decorators/excludes |
||
| 136 | * @see client/jsonapi/basket/address/decorators/global |
||
| 137 | */ |
||
| 138 | |||
| 139 | |||
| 140 | private \Aimeos\Controller\Frontend\Basket\Iface $controller; |
||
| 141 | |||
| 142 | |||
| 143 | /** |
||
| 144 | * Initializes the client |
||
| 145 | * |
||
| 146 | * @param \Aimeos\MShop\ContextIface $context MShop context object |
||
| 147 | */ |
||
| 148 | public function __construct( \Aimeos\MShop\ContextIface $context ) |
||
| 153 | } |
||
| 154 | |||
| 155 | |||
| 156 | /** |
||
| 157 | * Deletes the resource or the resource list |
||
| 158 | * |
||
| 159 | * @param \Psr\Http\Message\ServerRequestInterface $request Request object |
||
| 160 | * @param \Psr\Http\Message\ResponseInterface $response Response object |
||
| 161 | * @return \Psr\Http\Message\ResponseInterface Modified response object |
||
| 162 | */ |
||
| 163 | public function delete( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface |
||
| 164 | { |
||
| 165 | $view = $this->view(); |
||
| 166 | |||
| 167 | try |
||
| 168 | { |
||
| 169 | $this->clearCache(); |
||
| 170 | $this->controller->setType( $view->param( 'id', 'default' ) ); |
||
| 171 | |||
| 172 | $relId = $view->param( 'relatedid' ); |
||
| 173 | $body = (string) $request->getBody(); |
||
| 174 | |||
| 175 | if( $relId === '' || $relId === null ) |
||
| 176 | { |
||
| 177 | if( ( $payload = json_decode( $body ) ) === null || !isset( $payload->data ) ) { |
||
| 178 | throw new \Aimeos\Client\JsonApi\Exception( 'Invalid JSON in body', 400 ); |
||
| 179 | } |
||
| 180 | |||
| 181 | if( !is_array( $payload->data ) ) { |
||
| 182 | $payload->data = [$payload->data]; |
||
| 183 | } |
||
| 184 | |||
| 185 | foreach( $payload->data as $entry ) |
||
| 186 | { |
||
| 187 | if( !isset( $entry->id ) ) { |
||
| 188 | throw new \Aimeos\Client\JsonApi\Exception( 'Type (ID) is missing', 400 ); |
||
| 189 | } |
||
| 190 | |||
| 191 | $this->controller->deleteAddress( $entry->id ); |
||
| 192 | } |
||
| 193 | } |
||
| 194 | else |
||
| 195 | { |
||
| 196 | $this->controller->deleteAddress( $relId ); |
||
| 197 | } |
||
| 198 | |||
| 199 | |||
| 200 | $view->item = $this->controller->get(); |
||
| 201 | $status = 200; |
||
| 202 | } |
||
| 203 | catch( \Aimeos\MShop\Plugin\Provider\Exception $e ) |
||
| 204 | { |
||
| 205 | $status = 409; |
||
| 206 | $view->errors = $this->getErrorDetails( $e, 'mshop' ); |
||
| 207 | } |
||
| 208 | catch( \Aimeos\MShop\Exception $e ) |
||
| 209 | { |
||
| 210 | $status = 404; |
||
| 211 | $view->errors = $this->getErrorDetails( $e, 'mshop' ); |
||
| 212 | } |
||
| 213 | catch( \Exception $e ) |
||
| 214 | { |
||
| 215 | $status = $e->getCode() >= 100 && $e->getCode() < 600 ? $e->getCode() : 500; |
||
| 216 | $view->errors = $this->getErrorDetails( $e ); |
||
| 217 | } |
||
| 218 | |||
| 219 | return $this->render( $response, $view, $status ); |
||
| 220 | } |
||
| 221 | |||
| 222 | |||
| 223 | /** |
||
| 224 | * Updates the resource or the resource list partitially |
||
| 225 | * |
||
| 226 | * @param \Psr\Http\Message\ServerRequestInterface $request Request object |
||
| 227 | * @param \Psr\Http\Message\ResponseInterface $response Response object |
||
| 228 | * @return \Psr\Http\Message\ResponseInterface Modified response object |
||
| 229 | */ |
||
| 230 | public function patch( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface |
||
| 231 | { |
||
| 232 | $view = $this->view(); |
||
| 233 | |||
| 234 | try |
||
| 235 | { |
||
| 236 | $this->clearCache(); |
||
| 237 | $this->controller->setType( $view->param( 'id', 'default' ) ); |
||
| 238 | |||
| 239 | $body = (string) $request->getBody(); |
||
| 240 | |||
| 241 | if( ( $payload = json_decode( $body ) ) === null || !isset( $payload->data ) ) { |
||
| 242 | throw new \Aimeos\Client\JsonApi\Exception( 'Invalid JSON in body', 400 ); |
||
| 243 | } |
||
| 244 | |||
| 245 | if( !is_array( $payload->data ) ) { |
||
| 246 | $payload->data = [$payload->data]; |
||
| 247 | } |
||
| 248 | |||
| 249 | if( $relId = $view->param( 'relatedid' ) ) { |
||
| 250 | $this->controller->deleteAddress( $relId ); |
||
| 251 | } |
||
| 252 | |||
| 253 | foreach( $payload->data as $entry ) |
||
| 254 | { |
||
| 255 | if( !isset( $entry->id ) || !isset( $entry->attributes ) ) { |
||
| 256 | throw new \Aimeos\Client\JsonApi\Exception( 'Address type or attributes are missing', 400 ); |
||
| 257 | } |
||
| 258 | |||
| 259 | $this->controller->addAddress( $entry->id, (array) $entry->attributes ); |
||
| 260 | } |
||
| 261 | |||
| 262 | |||
| 263 | $view->item = $this->controller->get(); |
||
| 264 | $status = 200; |
||
| 265 | } |
||
| 266 | catch( \Aimeos\MShop\Plugin\Provider\Exception $e ) |
||
| 267 | { |
||
| 268 | $status = 409; |
||
| 269 | $view->errors = $this->getErrorDetails( $e, 'mshop' ); |
||
| 270 | } |
||
| 271 | catch( \Aimeos\MShop\Exception $e ) |
||
| 272 | { |
||
| 273 | $status = 404; |
||
| 274 | $view->errors = $this->getErrorDetails( $e, 'mshop' ); |
||
| 275 | } |
||
| 276 | catch( \Exception $e ) |
||
| 277 | { |
||
| 278 | $status = $e->getCode() >= 100 && $e->getCode() < 600 ? $e->getCode() : 500; |
||
| 279 | $view->errors = $this->getErrorDetails( $e ); |
||
| 280 | } |
||
| 281 | |||
| 282 | return $this->render( $response, $view, $status ); |
||
| 283 | } |
||
| 284 | |||
| 285 | |||
| 286 | /** |
||
| 287 | * Creates or updates the resource or the resource list |
||
| 288 | * |
||
| 289 | * @param \Psr\Http\Message\ServerRequestInterface $request Request object |
||
| 290 | * @param \Psr\Http\Message\ResponseInterface $response Response object |
||
| 291 | * @return \Psr\Http\Message\ResponseInterface Modified response object |
||
| 292 | */ |
||
| 293 | public function post( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface |
||
| 294 | { |
||
| 295 | $view = $this->view(); |
||
| 296 | |||
| 297 | try |
||
| 298 | { |
||
| 299 | $this->clearCache(); |
||
| 300 | $this->controller->setType( $view->param( 'id', 'default' ) ); |
||
| 301 | |||
| 302 | $body = (string) $request->getBody(); |
||
| 303 | |||
| 304 | if( ( $payload = json_decode( $body ) ) === null || !isset( $payload->data ) ) { |
||
| 305 | throw new \Aimeos\Client\JsonApi\Exception( 'Invalid JSON in body', 400 ); |
||
| 306 | } |
||
| 307 | |||
| 308 | if( !is_array( $payload->data ) ) { |
||
| 309 | $payload->data = [$payload->data]; |
||
| 310 | } |
||
| 311 | |||
| 312 | foreach( $payload->data as $entry ) |
||
| 313 | { |
||
| 314 | if( !isset( $entry->id ) || !isset( $entry->attributes ) ) { |
||
| 315 | throw new \Aimeos\Client\JsonApi\Exception( 'Address type or attributes are missing', 400 ); |
||
| 316 | } |
||
| 317 | |||
| 318 | $this->controller->addAddress( $entry->id, (array) $entry->attributes ); |
||
| 319 | } |
||
| 320 | |||
| 321 | |||
| 322 | $view->item = $this->controller->get(); |
||
| 323 | $status = 201; |
||
| 324 | } |
||
| 325 | catch( \Aimeos\MShop\Plugin\Provider\Exception $e ) |
||
| 326 | { |
||
| 327 | $status = 409; |
||
| 328 | $view->errors = $this->getErrorDetails( $e, 'mshop' ); |
||
| 329 | } |
||
| 330 | catch( \Aimeos\MShop\Exception $e ) |
||
| 331 | { |
||
| 332 | $status = 404; |
||
| 333 | $view->errors = $this->getErrorDetails( $e, 'mshop' ); |
||
| 334 | } |
||
| 335 | catch( \Exception $e ) |
||
| 336 | { |
||
| 337 | $status = $e->getCode() >= 100 && $e->getCode() < 600 ? $e->getCode() : 500; |
||
| 338 | $view->errors = $this->getErrorDetails( $e ); |
||
| 339 | } |
||
| 340 | |||
| 341 | return $this->render( $response, $view, $status ); |
||
| 342 | } |
||
| 343 | |||
| 344 | |||
| 345 | /** |
||
| 346 | * Returns the available REST verbs and the available parameters |
||
| 347 | * |
||
| 348 | * @param \Psr\Http\Message\ServerRequestInterface $request Request object |
||
| 349 | * @param \Psr\Http\Message\ResponseInterface $response Response object |
||
| 350 | * @return \Psr\Http\Message\ResponseInterface Modified response object |
||
| 351 | */ |
||
| 352 | public function options( ServerRequestInterface $request, ResponseInterface $response ) : \Psr\Http\Message\ResponseInterface |
||
| 353 | { |
||
| 354 | $view = $this->view(); |
||
| 355 | |||
| 356 | $view->attributes = [ |
||
| 357 | 'addressid' => [ |
||
| 358 | 'label' => 'ID of the customer address', |
||
| 359 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 360 | ], |
||
| 361 | 'salutation' => [ |
||
| 362 | 'label' => 'Customer salutation, i.e. "comany" ,"mr", "ms" or ""', |
||
| 363 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 364 | ], |
||
| 365 | 'company' => [ |
||
| 366 | 'label' => 'Company name', |
||
| 367 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 368 | ], |
||
| 369 | 'vatid' => [ |
||
| 370 | 'label' => 'VAT ID of the company', |
||
| 371 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 372 | ], |
||
| 373 | 'title' => [ |
||
| 374 | 'label' => 'Title of the customer', |
||
| 375 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 376 | ], |
||
| 377 | 'firstname' => [ |
||
| 378 | 'label' => 'First name of the customer', |
||
| 379 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 380 | ], |
||
| 381 | 'lastname' => [ |
||
| 382 | 'label' => 'Last name of the customer or full name', |
||
| 383 | 'type' => 'string', 'default' => '', 'required' => true, |
||
| 384 | ], |
||
| 385 | 'address1' => [ |
||
| 386 | 'label' => 'First address part like street', |
||
| 387 | 'type' => 'string', 'default' => '', 'required' => true, |
||
| 388 | ], |
||
| 389 | 'address2' => [ |
||
| 390 | 'label' => 'Second address part like house number', |
||
| 391 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 392 | ], |
||
| 393 | 'address3' => [ |
||
| 394 | 'label' => 'Third address part like flat number', |
||
| 395 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 396 | ], |
||
| 397 | 'postal' => [ |
||
| 398 | 'label' => 'Zip code of the city', |
||
| 399 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 400 | ], |
||
| 401 | 'city' => [ |
||
| 402 | 'label' => 'Name of the town/city', |
||
| 403 | 'type' => 'string', 'default' => '', 'required' => true, |
||
| 404 | ], |
||
| 405 | 'state' => [ |
||
| 406 | 'label' => 'Two letter code of the country state', |
||
| 407 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 408 | ], |
||
| 409 | 'countryid' => [ |
||
| 410 | 'label' => 'Two letter ISO country code', |
||
| 411 | 'type' => 'string', 'default' => '', 'required' => true, |
||
| 412 | ], |
||
| 413 | 'languageid' => [ |
||
| 414 | 'label' => 'Two or five letter ISO language code, e.g. "de" or "de_CH"', |
||
| 415 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 416 | ], |
||
| 417 | 'telephone' => [ |
||
| 418 | 'label' => 'Telephone number consisting of optional leading "+" and digits without spaces', |
||
| 419 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 420 | ], |
||
| 421 | 'telefax' => [ |
||
| 422 | 'label' => 'Facsimile number consisting of optional leading "+" and digits without spaces', |
||
| 423 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 424 | ], |
||
| 425 | 'email' => [ |
||
| 426 | 'label' => 'E-mail address', |
||
| 427 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 428 | ], |
||
| 429 | 'website' => [ |
||
| 430 | 'label' => 'Web site including "http://" or "https://"', |
||
| 431 | 'type' => 'string', 'default' => '', 'required' => false, |
||
| 432 | ], |
||
| 433 | 'longitude' => [ |
||
| 434 | 'label' => 'Longitude of the customer location as float value', |
||
| 435 | 'type' => 'float', 'default' => '', 'required' => false, |
||
| 436 | ], |
||
| 437 | 'latitude' => [ |
||
| 438 | 'label' => 'Latitude of the customer location as float value', |
||
| 439 | 'type' => 'float', 'default' => '', 'required' => false, |
||
| 440 | ], |
||
| 441 | ]; |
||
| 442 | |||
| 443 | $tplconf = 'client/jsonapi/template-options'; |
||
| 444 | $default = 'options-standard'; |
||
| 445 | |||
| 446 | $body = $view->render( $view->config( $tplconf, $default ) ); |
||
| 447 | |||
| 448 | return $response->withHeader( 'Allow', 'DELETE,GET,OPTIONS,PATCH,POST' ) |
||
| 449 | ->withHeader( 'Cache-Control', 'max-age=300' ) |
||
| 450 | ->withHeader( 'Content-Type', 'application/vnd.api+json' ) |
||
| 451 | ->withBody( $view->response()->createStreamFromString( $body ) ) |
||
| 452 | ->withStatus( 200 ); |
||
|
Bug
introduced
by
|
|||
| 453 | } |
||
| 454 | |||
| 455 | |||
| 456 | /** |
||
| 457 | * Returns the response object with the rendered header and body |
||
| 458 | * |
||
| 459 | * @param \Psr\Http\Message\ResponseInterface $response Response object |
||
| 460 | * @param \Aimeos\Base\View\Iface $view View instance |
||
| 461 | * @param int $status HTTP status code |
||
| 462 | * @return \Psr\Http\Message\ResponseInterface Modified response object |
||
| 463 | */ |
||
| 464 | protected function render( ResponseInterface $response, \Aimeos\Base\View\Iface $view, int $status ) : \Psr\Http\Message\ResponseInterface |
||
| 476 | } |
||
| 477 | } |
||
| 478 |
Loading history...