CTP SDK : File Core/Request/AbstractUpdateRequest.php

  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

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 * @created: 26.01.15, 17:22
 */

namespace Commercetools\Core\Request;

use Psr\Http\Message\ResponseInterface;
use Commercetools\Core\Client\HttpMethod;
use Commercetools\Core\Client\JsonEndpoint;
use Commercetools\Core\Client\JsonRequest;
use Commercetools\Core\Error\Message;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\ContextAwareInterface;
use Commercetools\Core\Response\ResourceResponse;
use Commercetools\Core\Error\UpdateActionLimitException;

/**
 * @package Commercetools\Core\Request
 */
abstract class AbstractUpdateRequest extends AbstractApiRequest
{
    use ExpandTrait;

    const ACTION = 'action';
    const ACTIONS = 'actions';
    const VERSION = 'version';
    const ACTION_MAX_LIMIT = 500;
    const ACTION_WARNING_TRESHOLD = 400;

    /**
     * @var string
     */
    protected $id;

    /**
     * @var int
     */
    protected $version;

    /**
     * @var AbstractAction[]
     */
    protected $actions = [];

    protected $overLimit = false;

    /**
     * @param JsonEndpoint $endpoint
     * @param string $id
     * @param int $version
     * @param array $actions
     * @param Context $context
     */
    public function __construct($endpoint, $id, $version, array $actions = [], Context $context = null)
    {
        parent::__construct($endpoint, $context);
        $this->setId($id)->setVersion($version)->setActions($actions);
    }

    /**
     * @return AbstractAction[]
     */
    public function getActions()
    {
        return $this->actions;
    }

    /**
     * @return bool
     */
    public function hasActions()
    {
        return (0 !== count($this->actions));
    }

    /**
     * @param AbstractAction[] $actions
     * @return $this
     */
    public function setActions(array $actions)
    {
        $this->actions = [];
        foreach ($actions as $action) {
            if ($action instanceof AbstractAction) {
                $this->addAction($action);
            } elseif (is_array($action)) {
                $this->addActionAsArray($action);
            }
        }

        return $this;
    }

    /**
     * @param AbstractAction $action
     * @return $this
     */
    public function addAction(AbstractAction $action)
    {
        $this->actions[] = $action;
        if ($action instanceof ContextAwareInterface) {
            $action->setContextIfNull($this->getContextCallback());
        }
        $this->checkActionLimit();

        return $this;
    }

    /**
     * @param array $action
     * @return $this
     */
    public function addActionAsArray(array $action)
    {
        $this->actions[] = $action;
        $this->checkActionLimit();

        return $this;
    }

    protected function checkActionLimit()
    {
        if (count($this->actions) > static::ACTION_MAX_LIMIT) {
            $message = sprintf(
                Message::UPDATE_ACTION_LIMIT,
                $this->getPath(),
                static::ACTION_MAX_LIMIT
            );
            throw new UpdateActionLimitException($message);
        }
        if (!$this->overLimit && count($this->actions) > static::ACTION_WARNING_TRESHOLD) {
            $this->overLimit = true;
            $logger = $this->getContext()->getLogger();
            if (!is_null($logger)) {
                $message = sprintf(
                    Message::UPDATE_ACTION_LIMIT_WARNING,
                    $this->getPath(),
                    static::ACTION_WARNING_TRESHOLD
                );
                $logger->warning($message);
            }
        }
    }

    /**
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param string $id
     * @return $this
     */
    public function setId($id)
    {
        $this->id = $id;

        return $this;
    }

    /**
     * @return int
     */
    public function getVersion()
    {
        return $this->version;
    }

    /**
     * @param int $version
     * @return $this
     */
    public function setVersion($version)
    {
        $this->version = $version;

        return $this;
    }

    /**
     * @return string
     * @internal
     */
    protected function getPath()
    {
        return (string)$this->getEndpoint() . '/' . $this->getId()  . $this->getParamString();
    }

    /**
     * @return JsonRequest
     * @internal
     */
    public function httpRequest()
    {
        $payload = [static::VERSION => $this->getVersion(), static::ACTIONS => $this->getActions()];
        return new JsonRequest(HttpMethod::POST, $this->getPath(), $payload);
    }

    /**
     * @param ResponseInterface $response
     * @return ResourceResponse
     * @internal
     */
    public function buildResponse(ResponseInterface $response)
    {
        return new ResourceResponse($response, $this, $this->getContext());
    }
}

Namespaces

Classes

Interfaces

Traits