CTP SDK : File Core/Response/PagedQueryResponse.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

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 * @created: 28.01.15, 09:26
 */

namespace Commercetools\Core\Response;

use GuzzleHttp\Message\ResponseInterface;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\ContextAwareInterface;
use Commercetools\Core\Model\Common\ContextTrait;
use Commercetools\Core\Model\Product\ProductProjectionCollection;
use Commercetools\Core\Request\ClientRequestInterface;
use Traversable;

/**
 * @package Commercetools\Core\Response
 */
class PagedQueryResponse extends AbstractApiResponse implements \IteratorAggregate, \ArrayAccess
{
    const COUNT = 'count';
    const OFFSET = 'offset';
    const TOTAL = 'total';
    const RESULTS = 'results';

    protected $count;
    protected $offset;
    protected $total;
    protected $results;

    protected function getResponseKey($key, $default = null)
    {
        $response = $this->toArray();
        if (isset($response[$key])) {
            return $response[$key];
        }

        return $default;
    }

    /**
     * @return int
     */
    public function getCount()
    {
        if (is_null($this->count)) {
            $this->count = $this->getResponseKey(static::COUNT);
        }
        return $this->count;
    }

    /**
     * @return int
     */
    public function getOffset()
    {
        if (is_null($this->offset)) {
            $this->offset = $this->getResponseKey(static::OFFSET);
        }
        return $this->offset;
    }

    /**
     * @return int
     */
    public function getTotal()
    {
        if (is_null($this->total)) {
            $this->total = $this->getResponseKey(static::TOTAL);
        }
        return $this->total;
    }

    /**
     * @return array
     */
    public function getResults()
    {
        if (is_null($this->results)) {
            $this->results = $this->getResponseKey(static::RESULTS, []);
        }
        return $this->results;
    }


    #[\ReturnTypeWillChange]
    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Retrieve an external iterator
     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
     * @return Traversable An instance of an object implementing <b>Iterator</b> or
     * <b>Traversable</b>
     */
    public function getIterator()
    {
        $this->getResults();
        return new \ArrayIterator($this->results);
    }

    #[\ReturnTypeWillChange]
    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Whether a offset exists
     * @link http://php.net/manual/en/arrayaccess.offsetexists.php
     * @param mixed $offset <p>
     * An offset to check for.
     * </p>
     * @return boolean true on success or false on failure.
     * </p>
     * <p>
     * The return value will be casted to boolean if non-boolean was returned.
     */
    public function offsetExists($offset)
    {
        $results = $this->getResults();
        return isset($results[$offset]);
    }

    #[\ReturnTypeWillChange]
    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Offset to retrieve
     * @link http://php.net/manual/en/arrayaccess.offsetget.php
     * @param mixed $offset <p>
     * The offset to retrieve.
     * </p>
     * @return mixed Can return all value types.
     */
    public function offsetGet($offset)
    {
        $results = $this->getResults();
        return $results[$offset];
    }

    #[\ReturnTypeWillChange]
    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Offset to set
     * @link http://php.net/manual/en/arrayaccess.offsetset.php
     * @param mixed $offset <p>
     * The offset to assign the value to.
     * </p>
     * @param mixed $value <p>
     * The value to set.
     * </p>
     * @return void
     */
    public function offsetSet($offset, $value)
    {
        $this->getResults();
        if (is_null($offset)) {
            $this->results[] = $value;
        } else {
            $this->results[$offset] = $value;
        }
    }

    #[\ReturnTypeWillChange]
    /**
     * (PHP 5 &gt;= 5.0.0)<br/>
     * Offset to unset
     * @link http://php.net/manual/en/arrayaccess.offsetunset.php
     * @param mixed $offset <p>
     * The offset to unset.
     * </p>
     * @return void
     */
    public function offsetUnset($offset)
    {
        $this->getResults();
        unset($this->results[$offset]);
    }
}

Namespaces

Classes

Interfaces