1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0 |
5
|
|
|
* @copyright Aimeos (aimeos.org), 2017 |
6
|
|
|
* @package Client |
7
|
|
|
* @subpackage JsonApi |
8
|
|
|
*/ |
9
|
|
|
|
10
|
|
|
|
11
|
|
|
namespace Aimeos\Client\JsonApi\Locale; |
12
|
|
|
|
13
|
|
|
use Psr\Http\Message\ResponseInterface; |
14
|
|
|
use Psr\Http\Message\ServerRequestInterface; |
15
|
|
|
|
16
|
|
|
|
17
|
|
|
/** |
18
|
|
|
* JSON API standard client |
19
|
|
|
* |
20
|
|
|
* @package Client |
21
|
|
|
* @subpackage JsonApi |
22
|
|
|
*/ |
23
|
|
|
class Standard |
24
|
|
|
extends \Aimeos\Client\JsonApi\Base |
25
|
|
|
implements \Aimeos\Client\JsonApi\Iface |
26
|
|
|
{ |
27
|
|
|
/** |
28
|
|
|
* Returns the resource or the resource list |
29
|
|
|
* |
30
|
|
|
* @param \Psr\Http\Message\ServerRequestInterface $request Request object |
31
|
|
|
* @param \Psr\Http\Message\ResponseInterface $response Response object |
32
|
|
|
* @return \Psr\Http\Message\ResponseInterface Modified response object |
33
|
|
|
*/ |
34
|
|
|
public function get( ServerRequestInterface $request, ResponseInterface $response ) |
35
|
|
|
{ |
36
|
|
|
$view = $this->getView(); |
37
|
|
|
|
38
|
|
|
try |
39
|
|
|
{ |
40
|
|
|
if( $view->param( 'id' ) != '' ) { |
41
|
|
|
$response = $this->getItem( $view, $request, $response ); |
42
|
|
|
} else { |
43
|
|
|
$response = $this->getItems( $view, $request, $response ); |
44
|
|
|
} |
45
|
|
|
|
46
|
|
|
$status = 200; |
47
|
|
|
} |
48
|
|
|
catch( \Aimeos\MShop\Exception $e ) |
49
|
|
|
{ |
50
|
|
|
$status = 404; |
51
|
|
|
$view->errors = $this->getErrorDetails( $e, 'mshop' ); |
52
|
|
|
} |
53
|
|
|
catch( \Exception $e ) |
54
|
|
|
{ |
55
|
|
|
$status = 500; |
56
|
|
|
$view->errors = $this->getErrorDetails( $e ); |
57
|
|
|
} |
58
|
|
|
|
59
|
|
|
/** client/jsonapi/locale/standard/template |
60
|
|
|
* Relative path to the locale lists JSON API template |
61
|
|
|
* |
62
|
|
|
* The template file contains the code and processing instructions |
63
|
|
|
* to generate the result shown in the JSON API body. The |
64
|
|
|
* configuration string is the path to the template file relative |
65
|
|
|
* to the templates directory (usually in client/jsonapi/templates). |
66
|
|
|
* |
67
|
|
|
* You can overwrite the template file configuration in extensions and |
68
|
|
|
* provide alternative templates. These alternative templates should be |
69
|
|
|
* named like the default one but with the string "standard" replaced by |
70
|
|
|
* an unique name. You may use the name of your project for this. If |
71
|
|
|
* you've implemented an alternative client class as well, "standard" |
72
|
|
|
* should be replaced by the name of the new class. |
73
|
|
|
* |
74
|
|
|
* @param string Relative path to the template creating the body for the GET method of the JSON API |
75
|
|
|
* @since 2017.03 |
76
|
|
|
* @category Developer |
77
|
|
|
*/ |
78
|
|
|
$tplconf = 'client/jsonapi/locale/standard/template'; |
79
|
|
|
$default = 'locale/standard.php'; |
80
|
|
|
|
81
|
|
|
$body = $view->render( $view->config( $tplconf, $default ) ); |
82
|
|
|
|
83
|
|
|
return $response->withHeader( 'Allow', 'GET' ) |
84
|
|
|
->withHeader( 'Content-Type', 'application/vnd.api+json' ) |
85
|
|
|
->withBody( $view->response()->createStreamFromString( $body ) ) |
86
|
|
|
->withStatus( $status ); |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
|
90
|
|
|
/** |
91
|
|
|
* Retrieves the item and adds the data to the view |
92
|
|
|
* |
93
|
|
|
* @param \Aimeos\MW\View\Iface $view View instance |
94
|
|
|
* @param \Psr\Http\Message\ServerRequestInterface $request Request object |
95
|
|
|
* @param \Psr\Http\Message\ResponseInterface $response Response object |
96
|
|
|
* @return \Psr\Http\Message\ResponseInterface Modified response object |
97
|
|
|
*/ |
98
|
|
|
protected function getItem( \Aimeos\MW\View\Iface $view, ServerRequestInterface $request, ResponseInterface $response ) |
|
|
|
|
99
|
|
|
{ |
100
|
|
|
$cntl = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'locale' ); |
101
|
|
|
|
102
|
|
|
$view->items = $cntl->getItem( $view->param( 'id' ) ); |
103
|
|
|
$view->total = 1; |
104
|
|
|
|
105
|
|
|
return $response; |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
|
109
|
|
|
/** |
110
|
|
|
* Retrieves the items and adds the data to the view |
111
|
|
|
* |
112
|
|
|
* @param \Aimeos\MW\View\Iface $view View instance |
113
|
|
|
* @param \Psr\Http\Message\ServerRequestInterface $request Request object |
114
|
|
|
* @param \Psr\Http\Message\ResponseInterface $response Response object |
115
|
|
|
* @return \Psr\Http\Message\ResponseInterface Modified response object |
116
|
|
|
*/ |
117
|
|
|
protected function getItems( \Aimeos\MW\View\Iface $view, ServerRequestInterface $request, ResponseInterface $response ) |
|
|
|
|
118
|
|
|
{ |
119
|
|
|
$total = 0; |
120
|
|
|
|
121
|
|
|
$cntl = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'locale' ); |
122
|
|
|
|
123
|
|
|
$filter = $cntl->createFilter(); |
124
|
|
|
$filter = $this->initCriteriaConditions( $filter, $view->param() ); |
125
|
|
|
|
126
|
|
|
$view->items = $cntl->searchItems( $filter, [], $total ); |
127
|
|
|
$view->total = $total; |
128
|
|
|
|
129
|
|
|
return $response; |
130
|
|
|
} |
131
|
|
|
} |
132
|
|
|
|
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.