Composable Commerce PHP SDKPHP SDK
  • Namespace
  • Class
  • Tree

Namespaces

  • Commercetools
    • Commons
      • Helper
    • Core
      • Builder
        • Request
        • Update
      • Cache
      • Client
        • Adapter
        • OAuth
      • Error
      • Helper
        • Annotate
        • State
          • Renderer
        • Subscriber
          • Log
      • Model
        • ApiClient
        • Cart
        • CartDiscount
        • Category
        • Channel
        • Common
        • Customer
        • CustomerGroup
        • CustomField
        • CustomObject
        • DiscountCode
        • Extension
        • Inventory
        • Message
        • Order
        • OrderEdit
        • Payment
        • Product
          • Search
        • ProductDiscount
        • ProductSelection
        • ProductType
        • Project
        • Review
        • ShippingMethod
        • ShoppingList
        • State
        • Store
        • Subscription
        • TaxCategory
        • Type
        • Zone
      • Request
        • ApiClients
        • CartDiscounts
          • Command
        • Carts
          • Command
        • Categories
          • Command
        • Channels
          • Command
        • CustomerGroups
          • Command
        • Customers
          • Command
        • CustomField
          • Command
        • CustomObjects
        • DiscountCodes
          • Command
        • Extensions
          • Command
        • GraphQL
        • InStores
        • Inventory
          • Command
        • Me
          • Command
        • Messages
        • OrderEdits
          • Command
          • StagedOrder
            • Command
        • Orders
          • Command
        • Payments
          • Command
        • ProductDiscounts
          • Command
        • Products
          • Command
        • ProductSelections
          • Command
        • ProductTypes
          • Command
        • Project
          • Command
        • Query
        • Reviews
          • Command
        • ShippingMethods
          • Command
        • ShoppingLists
          • Command
        • States
          • Command
        • Stores
          • Command
        • Subscriptions
          • Command
        • TaxCategories
          • Command
        • Types
          • Command
        • Zones
          • Command
      • Response

Classes

  • ActionBuilder
  • CartDiscountsActionBuilder
  • CartsActionBuilder
  • CategoriesActionBuilder
  • ChannelsActionBuilder
  • CustomerGroupsActionBuilder
  • CustomersActionBuilder
  • CustomFieldActionBuilder
  • DiscountCodesActionBuilder
  • ExtensionsActionBuilder
  • InventoryActionBuilder
  • MeActionBuilder
  • OrderEditsActionBuilder
  • OrdersActionBuilder
  • PaymentsActionBuilder
  • ProductDiscountsActionBuilder
  • ProductsActionBuilder
  • ProductSelectionsActionBuilder
  • ProductTypesActionBuilder
  • ProjectActionBuilder
  • ReviewsActionBuilder
  • ShippingMethodsActionBuilder
  • ShoppingListsActionBuilder
  • StagedOrderActionBuilder
  • StatesActionBuilder
  • StoresActionBuilder
  • SubscriptionsActionBuilder
  • TaxCategoriesActionBuilder
  • TypesActionBuilder
  • ZonesActionBuilder
  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 
<?php

namespace Commercetools\Core\Builder\Update;

use Commercetools\Core\Error\InvalidArgumentException;
use Commercetools\Core\Request\AbstractAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodAddShippingRateAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodAddZoneAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodChangeIsDefaultAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodChangeNameAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodChangeTaxCategoryAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodRemoveShippingRateAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodRemoveZoneAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodSetCustomFieldAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodSetCustomTypeAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodSetDescriptionAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodSetKeyAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodSetLocalizedDescriptionAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodSetLocalizedNameAction;
use Commercetools\Core\Request\ShippingMethods\Command\ShippingMethodSetPredicateAction;

class ShippingMethodsActionBuilder
{
    private $actions = [];

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#add-shippingrate
     * @param ShippingMethodAddShippingRateAction|callable $action
     * @return $this
     */
    public function addShippingRate($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodAddShippingRateAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#add-zone
     * @param ShippingMethodAddZoneAction|callable $action
     * @return $this
     */
    public function addZone($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodAddZoneAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#change-isdefault
     * @param ShippingMethodChangeIsDefaultAction|callable $action
     * @return $this
     */
    public function changeIsDefault($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodChangeIsDefaultAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#change-name
     * @param ShippingMethodChangeNameAction|callable $action
     * @return $this
     */
    public function changeName($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodChangeNameAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#change-taxcategory
     * @param ShippingMethodChangeTaxCategoryAction|callable $action
     * @return $this
     */
    public function changeTaxCategory($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodChangeTaxCategoryAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#remove-shippingrate
     * @param ShippingMethodRemoveShippingRateAction|callable $action
     * @return $this
     */
    public function removeShippingRate($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodRemoveShippingRateAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#remove-zone
     * @param ShippingMethodRemoveZoneAction|callable $action
     * @return $this
     */
    public function removeZone($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodRemoveZoneAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/api/projects/shippingMethods#set-customfield
     * @param ShippingMethodSetCustomFieldAction|callable $action
     * @return $this
     */
    public function setCustomField($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodSetCustomFieldAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/api/projects/shippingMethods#set-customtype
     * @param ShippingMethodSetCustomTypeAction|callable $action
     * @return $this
     */
    public function setCustomType($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodSetCustomTypeAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#set-description
     * @param ShippingMethodSetDescriptionAction|callable $action
     * @return $this
     */
    public function setDescription($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodSetDescriptionAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#set-key
     * @param ShippingMethodSetKeyAction|callable $action
     * @return $this
     */
    public function setKey($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodSetKeyAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#set-localized-description
     * @param ShippingMethodSetLocalizedDescriptionAction|callable $action
     * @return $this
     */
    public function setLocalizedDescription($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodSetLocalizedDescriptionAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/api/projects/shippingMethods#set-localized-name
     * @param ShippingMethodSetLocalizedNameAction|callable $action
     * @return $this
     */
    public function setLocalizedName($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodSetLocalizedNameAction::class, $action));
        return $this;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-shippingMethods.html#set-predicate
     * @param ShippingMethodSetPredicateAction|callable $action
     * @return $this
     */
    public function setPredicate($action = null)
    {
        $this->addAction($this->resolveAction(ShippingMethodSetPredicateAction::class, $action));
        return $this;
    }

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

    /**
     * @param $class
     * @param $action
     * @return AbstractAction
     * @throws InvalidArgumentException
     */
    private function resolveAction($class, $action = null)
    {
        if (is_null($action) || is_callable($action)) {
            $callback = $action;
            $emptyAction = $class::of();
            $action = $this->callback($emptyAction, $callback);
        }
        if ($action instanceof $class) {
            return $action;
        }
        throw new InvalidArgumentException(
            sprintf('Expected method to be called with or callable to return %s', $class)
        );
    }

    /**
     * @param $action
     * @param callable $callback
     * @return AbstractAction
     */
    private function callback($action, callable $callback = null)
    {
        if (!is_null($callback)) {
            $action = $callback($action);
        }
        return $action;
    }

    /**
     * @param AbstractAction $action
     * @return $this;
     */
    public function addAction(AbstractAction $action)
    {
        $this->actions[] = $action;
        return $this;
    }

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


    /**
     * @param array $actions
     * @return $this
     */
    public function setActions(array $actions)
    {
        $this->actions = $actions;
        return $this;
    }
}
PHP SDK API documentation generated by ApiGen