1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 

<?php
/* --------------------------------------------------------------
   ManufacturersApiV2Controller.inc.php 2018-01-23
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2018 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

class ManufacturersApiV2Controller extends HttpApiV2Controller
{
    /**
     * @var \ManufacturerReadServiceInterface
     */
    protected $readService;
    
    /**
     * @var \ManufacturerWriteServiceInterface
     */
    protected $writeService;
    
    
    /**
     * Initializes the manufacturers api controller.
     */
    protected function __initialize()
    {
        $this->readService  = StaticGXCoreLoader::getService('ManufacturerRead');
        $this->writeService = StaticGXCoreLoader::getService('ManufacturerWrite');
    }
    
    
    /**
     * @api             {get} /manufacturers/:id Get manufacturers
     * @apiVersion      2.5.0
     * @apiName         GetManufacturers
     * @apiGroup        Manufacturers
     *
     * @apiDescription
     * Get multiple or a single manufacturers record through the GET method
     *
     * @apiExample {curl} Get All Manufacturers records
     *             curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/manufacturers
     *
     * @apiExample {curl} Get Manufacturers record With ID = 982
     *             curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/manufacturers/982
     *
     * @apiError        400-BadRequest Manufacturers data were not provided or manufacturers record ID was not provided
     *                  or is invalid.
     *
     * @apiErrorExample Error-Response (Missing or invalid ID)
     * HTTP/1.1 400 Bad Request
     * {
     *   "code": 400,
     *   "status": "error",
     *   "message": "Manufacturers record ID was not provided or is invalid."
     * }
     *
     * @apiError        404-NotFound Manufacturers record could not be found.
     *
     * @apiErrorExample Error-Response (Manufacturers Not Found)
     * HTTP/1.1 404 Not Found
     * {
     *   "code": 404,
     *   "status": "error",
     *   "message": "Manufacturers record could not be found."
     * }
     */
    public function get()
    {
        if(isset($this->uri[1]) && is_numeric($this->uri[1]))
        {
            try
            {
                $manufacturer = $this->readService->getById(new IdType((int)$this->uri[1]));
                
                return $this->_writeResponse($this->_serializeManufacturer($manufacturer));
            }
            catch(EntityNotFoundException $e)
            {
                throw new HttpApiV2Exception($e->getMessage(), 404, $e);
            }
        }
        
        if(isset($this->uri[1]) && !is_numeric($this->uri[1]))
        {
            throw new HttpApiV2Exception('Manufacturer record is was not provided', 400);
        }
        
        return $this->_writeResponse($this->_serializeManufacturerCollection($this->readService->getAll()));
    }
    
    
    /**
     * @api             {post} /manufacturers Create Manufacturers
     * @apiVersion      2.6.0
     * @apiName         CreateManufacturers
     * @apiGroup        Manufacturers
     *
     * @apiDescription
     * This method enables the creation of a new Manufacturers into the system.
     *
     * @apiParamExample {json} Manufacturers entity
     * {
     *      "name": "Breitling",
     *      "image": "manufacturers/breitling-logo.png",
     *      "urls": {
     *          "EN": "https://breitling.com",
     *          "DE": "https://breitling.de"
     *      }
     * }
     *
     * @apiParam {String} name Name of manufacturer.
     * @apiParam {String} image Path to manufacturers image.
     * @apiParam {Object} urls Object with language code as key and the language specific url as value.
     *
     * @apiSuccess (201) Request-Body If successful, this method returns the complete manufacturers resource
     * in the response body.
     *
     * @apiSuccessExample {json} Success-Response
     *  {
     *      "id": 2,
     *      "name": "Breitling",
     *      "image": "manufacturers/breitling-logo.png",
     *      "dateAdded": "2017-09-29 13:42:46",
     *      "lastModified": "2017-09-29 13:42:46",
     *      "urls": {
     *          "EN": "https://breitling.com",
     *          "DE": "https://breitling.de"
     *      }
     *  }
     *
     * @apiError        400-BadRequest The body of the request was empty.
     * @apiErrorExample Error-Response
     * HTTP/1.1 400 Bad Request
     * {
     *   "code": 400,
     *   "status": "error",
     *   "message": "Manufacturers data were not provided."
     * }
     */
    public function post()
    {
        $manufacturer = $this->_deserializeManufacturer($this->api->request->getBody());
        $this->writeService->save($manufacturer);
        
        $this->_writeResponse($this->_serializeManufacturer($manufacturer));
    }
    
    
    /**
     * @api             {patch} /manufacturers/:id Updates Manufacturers
     * @apiVersion      2.6.0
     * @apiName         UpdateManufacturers
     * @apiGroup        Manufacturers
     *
     * @apiDescription
     * Use this method if you want to update an existing manufacturers record.
     *
     * @apiParamExample {json} Manufacturers entity
     * {
     *      "name": "Breitling",
     *      "image": "manufacturers/breitling-logo.png",
     *      "urls": {
     *          "EN": "https://breitling.com",
     *          "DE": "https://breitling.de"
     *      }
     * }
     *
     * @apiParam {String} name Name of manufacturer.
     * @apiParam {String} image Path to manufacturers image.
     * @apiParam {Object} urls Object with language code as key and the language specific url as value.
     *
     * @apiSuccess (200) Request-Body If successful, this method returns the complete manufacturers resource
     * in the response body.
     *
     * @apiSuccessExample {json} Success-Response
     *  {
     *      "id": 2,
     *      "name": "Breitling",
     *      "image": "manufacturers/breitling-logo.png",
     *      "dateAdded": "2017-09-29 13:42:46",
     *      "lastModified": "2017-09-29 13:42:46",
     *      "urls": {
     *          "EN": "https://breitling.com",
     *          "DE": "https://breitling.de"
     *      }
     *  }
     *
     * @apiError        400-BadRequest Manufacturers data were not provided or manufacturers record ID was not provided
     *                  or is invalid.
     *
     * @apiErrorExample Error-Response (Empty request body)
     * HTTP/1.1 400 Bad Request
     * {
     *   "code": 400,
     *   "status": "error",
     *   "message": "Manufacturers data were not provided."
     * }
     *
     * @apiErrorExample Error-Response (Missing or invalid ID)
     * HTTP/1.1 400 Bad Request
     * {
     *   "code": 400,
     *   "status": "error",
     *   "message": "Manufacturers record ID was not provided or is invalid."
     * }
     *
     * @apiError        404-NotFoundRequest Manufacturers data were not provided or manufacturers record ID was not
     *                  provided or is invalid.
     *
     * @apiErrorExample Error-Response (Entity not found)
     * HTTP/1.1 400 Bad Request
     * {
     *   "code": 404,
     *   "status": "error",
     *   "message": "Manufacturer entity was not found with provided id [ID]"
     * }
     */
    public function patch()
    {
        if(!isset($this->uri[1]) || !is_numeric($this->uri[1]))
        {
            throw new HttpApiV2Exception('Manufacturer record ID was not provided or is invalid in the Request-URI');
        }
        
        $requestBody = $this->api->request->getBody();
        if(empty($requestBody))
        {
            throw new HttpApiV2Exception('Manufacturer data were not provided.', 400);
        }
        
        try
        {
            $manufacturer = $this->_deserializeManufacturer($requestBody, $this->uri[1]);
            $this->writeService->save($manufacturer);
            $this->_writeResponse($this->_serializeManufacturer($manufacturer));
        }
        catch(EntityNotFoundException $e)
        {
            throw new HttpApiV2Exception($e->getMessage(), 404, $e);
        }
    }
    
    
    /**
     * @api        {delete} /manufacturers/:id Delete Manufacturers
     * @apiVersion 2.5.0
     * @apiName    DeleteManufacturers
     * @apiGroup   Manufacturers
     *
     * @apiDescription
     * Removes a manufacturers record from the system. This method will always return success
     * even if the manufacturers does not exist (due to internal ManufacturersWriteService architecture
     * decisions, which strive to avoid unnecessary failures).
     *
     * @apiExample {curl} Delete Manufacturers with ID = 84
     *             curl -X DELETE --user admin@shop.de:12345 http://shop.de/api.php/v2/manufacturers/84
     *
     * @apiSuccessExample {json} Success-Response
     * {
     *   "code": 200,
     *   "status": "success",
     *   "action": "delete",
     *   "manufacturersId": 84
     * }
     */
    public function delete()
    {
        if(!isset($this->uri[1]) || !is_numeric($this->uri[1]))
        {
            throw new HttpApiV2Exception('Manufacturer record ID was not provided or is invalid in the Request-URI');
        }
        
        try
        {
            $manufacturer = $this->readService->getById(new IdType($this->uri[1]));
            $this->writeService->delete($manufacturer);
        }
        catch(EntityNotFoundException $e)
        {
        }
        
        $this->_writeResponse([
                                  'code'           => 200,
                                  'status'         => 'success',
                                  'action'         => 'delete',
                                  'manufacturerId' => $this->uri[1]
                              ]);
    }
    
    
    /**
     * Serializes manufacturer entities.
     *
     * @param \ManufacturerInterface $manufacturer Manufacturer entity to be serialized.
     *
     * @return array Serialized manufacturer array.
     */
    protected function _serializeManufacturer(ManufacturerInterface $manufacturer)
    {
        return [
            'id'           => $manufacturer->getId(),
            'name'         => $manufacturer->getName(),
            'image'        => $manufacturer->getImage(),
            'dateAdded'    => $manufacturer->getDateAdded()->format('Y-m-d H:i:s'),
            'lastModified' => $manufacturer->getLastModified()->format('Y-m-d H:i:s'),
            'urls'         => $manufacturer->getUrls(),
        ];
    }
    
    
    /**
     * Deserialize manufacturer entities.
     *
     * @param string $manufacturerJson Manufacturer entity as json string.
     *
     * @return Manufacturer Deserialize manufacturer entity.
     */
    protected function _deserializeManufacturer($manufacturerJson, $id = null)
    {
        $manufacturerData = json_decode($manufacturerJson, true);
        $manufacturer     = $id ? $this->readService->getById(new IdType($id)) : $this->writeService->createManufacturer();
        
        $manufacturer->setName(new StringType($manufacturerData['name']))
                     ->setImage(new StringType($manufacturerData['image']));
        
        foreach($manufacturerData['urls'] as $languageCode => $url)
        {
            $manufacturer->setUrl(new StringType($url), new LanguageCode(new StringType($languageCode)));
        }
        
        return $manufacturer;
    }
    
    
    /**
     * Serializes manufacturer collections.
     *
     * @param \ManufacturerCollection $manufacturerCollection Manufacturer collection to be serialized.
     *
     * @return array Serialized manufacturer collection array.
     */
    protected function _serializeManufacturerCollection(ManufacturerCollection $manufacturerCollection)
    {
        $data = [];
        foreach($manufacturerCollection->getArray() as $manufacturer)
        {
            $data[] = $this->_serializeManufacturer($manufacturer);
        }
        
        return $data;
    }
}