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 

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

class QuantityUnitsApiV2Controller extends HttpApiV2Controller
{
    /**
     * @var QuantityUnitReadServiceInterface
     */
    protected $readService;
    
    /**
     * @var QuantityUnitWriteServiceInterface
     */
    protected $writeService;
    
    
    /**
     * Initializes the quantity unit api controller.
     */
    protected function __initialize()
    {
        $this->readService  = StaticGXCoreLoader::getService('QuantityUnitRead');
        $this->writeService = StaticGXCoreLoader::getService('QuantityUnitWrite');
    }
    
    
    /**
     * @api             {get} /quantity_units/:id Get quantity units
     * @apiVersion      2.5.0
     * @apiName         GetQuantityUnits
     * @apiGroup        QuantityUnits
     *
     * @apiDescription
     * Get multiple or a single quantity units record through the GET method
     *
     * @apiExample {curl} Get All QuantityUnits records
     *             curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/quantity_units
     *
     * @apiExample {curl} Get QuantityUnits record With ID = 982
     *             curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/quantity_units/982
     *
     * @apiError        400-BadRequest QuantityUnits data were not provided or quantity units 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": "QuantityUnits record ID was not provided or is invalid."
     * }
     *
     * @apiError        404-NotFound QuantityUnits record could not be found.
     *
     * @apiErrorExample Error-Response (QuantityUnits Not Found)
     * HTTP/1.1 404 Not Found
     * {
     *   "code": 404,
     *   "status": "error",
     *   "message": "QuantityUnits record could not be found."
     * }
     */
    public function get()
    {
        if(isset($this->uri[1]) && is_numeric($this->uri[1]))
        {
            try
            {
                $quantityUnit = $this->readService->getById(new IdType((int)$this->uri[1]));
                
                return $this->_writeResponse($this->_serializeQuantityUnit($quantityUnit));
            }
            catch(EntityNotFoundException $e)
            {
                throw new HttpApiV2Exception($e->getMessage(), 404, $e);
            }
        }
        
        if(isset($this->uri[1]) && !is_numeric($this->uri[1]))
        {
            throw new HttpApiV2Exception('Quantity unit record is was not provided', 400);
        }
        
        return $this->_writeResponse($this->_serializeQuantityUnitCollection($this->readService->getAll()));
    }
    
    
    /**
     * @api             {post} /quantity_units Create QuantityUnits
     * @apiVersion      2.5.0
     * @apiName         CreateQuantityUnits
     * @apiGroup        QuantityUnits
     *
     * @apiDescription
     * This method enables the creation of a new QuantityUnits into the system.
     *
     * @apiParamExample {json} QuantityUnits entity
     *  {
     *      "names": {
     *          "EN": "piece",
     *          "DE": "Stück"
     *      }
     *  }
     *
     * @apiParam {Object} names Object with language code as keys and name as values.
     *
     * @apiSuccess (201) Request-Body If successful, this method returns the complete quantity units resource
     * in the response body.
     *
     * @apiSuccessExample {json} Success-Response
     *  {
     *      "id": 2,
     *      "names": {
     *          "EN": "piece",
     *          "DE": "Stück"
     *      }
     *  }
     *
     * @apiError        400-BadRequest The body of the request was empty.
     * @apiErrorExample Error-Response
     * HTTP/1.1 400 Bad Request
     * {
     *   "code": 400,
     *   "status": "error",
     *   "message": "QuantityUnits data were not provided."
     * }
     */
    public function post()
    {
        $quantityUnit = $this->_deserializeQuantityUnit($this->api->request->getBody());
        $this->writeService->save($quantityUnit);
        
        $this->_writeResponse($this->_serializeQuantityUnit($quantityUnit));
    }
    
    
    /**
     * @api             {patch} /quantity_units/:id Updates QuantityUnit entity
     * @apiVersion      2.5.0
     * @apiName         UpdateQuantityUnits
     * @apiGroup        QuantityUnits
     *
     * @apiDescription
     * Use this method if you want to update an existing quantity units record.
     *
     * @apiParamExample {json} QuantityUnits entity
     *  {
     *      "names": {
     *          "EN": "piece",
     *          "DE": "Stück"
     *      }
     *  }
     *
     * @apiParam {Object} names Object with language code as keys and name as values.
     *
     * @apiSuccess (200) Request-Body If successful, this method returns the complete quantity units resource
     * in the response body.
     *
     * @apiSuccessExample {json} Success-Response
     *  {
     *      "id": 2,
     *      "names": {
     *          "EN": "piece",
     *          "DE": "Stück"
     *      }
     *  }
     *
     * @apiError        400-BadRequest QuantityUnits data were not provided or quantityUnits 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": "QuantityUnits data were not provided."
     * }
     *
     * @apiErrorExample Error-Response (Missing or invalid ID)
     * HTTP/1.1 400 Bad Request
     * {
     *   "code": 400,
     *   "status": "error",
     *   "message": "QuantityUnits record ID was not provided or is invalid."
     * }
     *
     * @apiError        404-NotFoundRequest QuantityUnits data were not provided or quantity unit 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": "Quantity unit entity was not found with provided id [ID]"
     * }
     */
    public function patch()
    {
        if(!isset($this->uri[1]) || !is_numeric($this->uri[1]))
        {
            throw new HttpApiV2Exception('Quantity unit record ID was not provided or is invalid in the Request-URI');
        }
        
        $requestBody = $this->api->request->getBody();
        if(empty($requestBody))
        {
            throw new HttpApiV2Exception('Quantity unit data were not provided.', 400);
        }
        
        try
        {
            $quantityUnit = $this->_deserializeQuantityUnit($requestBody, $this->uri[1]);
            $this->writeService->save($quantityUnit);
            $this->_writeResponse($this->_serializeQuantityUnit($quantityUnit));
        }
        catch(EntityNotFoundException $e)
        {
            throw new HttpApiV2Exception($e->getMessage(), 404, $e);
        }
    }
    
    
    /**
     * @api        {delete} /quantity_units/:id Delete QuantityUnits
     * @apiVersion 2.5.0
     * @apiName    DeleteQuantityUnits
     * @apiGroup   QuantityUnits
     *
     * @apiDescription
     * Removes a quantity units record from the system. This method will always return success
     * even if the quantity unit does not exist.
     *
     * @apiExample {curl} Delete QuantityUnits with ID = 84
     *             curl -X DELETE --user admin@shop.de:12345 http://shop.de/api.php/v2/quantity_units/84
     *
     * @apiSuccessExample {json} Success-Response
     * {
     *   "code": 200,
     *   "status": "success",
     *   "action": "delete",
     *   "quantityUnitId": 84
     * }
     */
    public function delete()
    {
        if(!isset($this->uri[1]) || !is_numeric($this->uri[1]))
        {
            throw new HttpApiV2Exception('Quantity unit record ID was not provided or is invalid in the Request-URI');
        }
        
        $quantityUnit = $this->readService->getById(new IdType($this->uri[1]));
        $this->writeService->delete($quantityUnit);
        
        $this->_writeResponse([
                                  'code'           => 200,
                                  'status'         => 'success',
                                  'action'         => 'delete',
                                  'quantityUnitId' => $quantityUnit->getId()
                              ]);
    }
    
    
    /**
     * Deserialize a json string to a quantity unit entity.
     *
     * @param string   $quantityUnitJson Quantity unit json to be serialized.
     * @param int|null $quantityUnitId   (Optional) Id of entity to be deserialize.
     *
     * @return \QuantityUnitInterface Deserialize quantity unit entity.
     */
    protected function _deserializeQuantityUnit($quantityUnitJson, $quantityUnitId = null)
    {
        $quantityUnitData = json_decode($quantityUnitJson, true);
        
        $quantityUnit = $quantityUnitId ? $this->readService->getById(new IdType($quantityUnitId)) : $this->writeService->createQuantityUnit();
        
        foreach($quantityUnitData['names'] as $languageCode => $name)
        {
            $quantityUnit->setName(new StringType($name), new LanguageCode(new StringType($languageCode)));
        }
        
        return $quantityUnit;
    }
    
    
    /**
     * Serializes a quantity unit entity collection.
     *
     * @param \QuantityUnitCollection $quantityUnitCollection Collection to be serialized.
     *
     * @return array Serialized quantity unit collection array.
     */
    protected function _serializeQuantityUnitCollection(QuantityUnitCollection $quantityUnitCollection)
    {
        $data = [];
        foreach($quantityUnitCollection->getArray() as $quantityUnit)
        {
            $data[] = $this->_serializeQuantityUnit($quantityUnit);
        }
        
        return $data;
    }
    
    
    /**
     * Serializes a quantity unit entity.
     *
     * @param \QuantityUnitInterface $quantityUnit Quantity unit to be serialized.
     *
     * @return array Serialized quantity unit array.
     */
    protected function _serializeQuantityUnit(QuantityUnitInterface $quantityUnit)
    {
        return [
            'id'    => $quantityUnit->getId(),
            'names' => $quantityUnit->getNames()
        ];
    }
}