CTP SDK : File Core/Builder/Request/ZoneRequestBuilder.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

<?php
// phpcs:disable Generic.Files.LineLength
namespace Commercetools\Core\Builder\Request;

use Commercetools\Core\Request\Zones\ZoneByIdGetRequest;
use Commercetools\Core\Request\Zones\ZoneByKeyGetRequest;
use Commercetools\Core\Request\Zones\ZoneCreateRequest;
use Commercetools\Core\Model\Zone\ZoneDraft;
use Commercetools\Core\Request\Zones\ZoneDeleteByKeyRequest;
use Commercetools\Core\Model\Zone\Zone;
use Commercetools\Core\Request\Zones\ZoneDeleteRequest;
use Commercetools\Core\Request\Zones\ZoneQueryRequest;
use Commercetools\Core\Request\Zones\ZoneUpdateByKeyRequest;
use Commercetools\Core\Request\Zones\ZoneUpdateRequest;

class ZoneRequestBuilder
{

    /**
     * @link https://docs.commercetools.com/http-api-projects-zones.html#get-zone-by-id
     * @param string $id
     * @return ZoneByIdGetRequest
     */
    public function getById($id)
    {
        $request = ZoneByIdGetRequest::ofId($id);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-zones.html#get-zone-by-key
     * @param string $key
     * @return ZoneByKeyGetRequest
     */
    public function getByKey($key)
    {
        $request = ZoneByKeyGetRequest::ofKey($key);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-zones.html#create-zone
     * @param ZoneDraft $zone
     * @return ZoneCreateRequest
     */
    public function create(ZoneDraft $zone)
    {
        $request = ZoneCreateRequest::ofDraft($zone);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-zones.html#delete-zone-by-key
     * @param Zone $zone
     * @return ZoneDeleteByKeyRequest
     */
    public function deleteByKey(Zone $zone)
    {
        $request = ZoneDeleteByKeyRequest::ofKeyAndVersion($zone->getKey(), $zone->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-zones.html#delete-zone
     * @param Zone $zone
     * @return ZoneDeleteRequest
     */
    public function delete(Zone $zone)
    {
        $request = ZoneDeleteRequest::ofIdAndVersion($zone->getId(), $zone->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-zones.html#query-zones
     *
     * @return ZoneQueryRequest
     */
    public function query()
    {
        $request = ZoneQueryRequest::of();
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-zones.html#update-zone-by-key
     * @param Zone $zone
     * @return ZoneUpdateByKeyRequest
     */
    public function updateByKey(Zone $zone)
    {
        $request = ZoneUpdateByKeyRequest::ofKeyAndVersion($zone->getKey(), $zone->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-zones.html#update-zone
     * @param Zone $zone
     * @return ZoneUpdateRequest
     */
    public function update(Zone $zone)
    {
        $request = ZoneUpdateRequest::ofIdAndVersion($zone->getId(), $zone->getVersion());
        return $request;
    }

    /**
     * @return ZoneRequestBuilder
     */
    public function of()
    {
        return new self();
    }
}

Namespaces

Classes