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 <?php
/**
* @author @jenschude <jens.schulze@commercetools.de>
*/
namespace Commercetools\Core\Model\State;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\JsonObject;
use Commercetools\Core\Model\Common\LocalizedString;
/**
* @package Commercetools\Core\Model\State
* @link https://docs.commercetools.com/http-api-projects-states.html#statedraft
* @method string getKey()
* @method StateDraft setKey(string $key = null)
* @method string getType()
* @method StateDraft setType(string $type = null)
* @method LocalizedString getName()
* @method StateDraft setName(LocalizedString $name = null)
* @method LocalizedString getDescription()
* @method StateDraft setDescription(LocalizedString $description = null)
* @method bool getInitial()
* @method StateDraft setInitial(bool $initial = null)
* @method StateReferenceCollection getTransitions()
* @method StateDraft setTransitions(StateReferenceCollection $transitions = null)
* @method array getRoles()
* @method StateDraft setRoles(array $roles = null)
*/
class StateDraft extends JsonObject
{
const TYPE_LINE_ITEM_STATE = 'LineItemState';
public function fieldDefinitions()
{
return [
'key' => [static::TYPE => 'string'],
'type' => [static::TYPE => 'string'],
'name' => [static::TYPE => LocalizedString::class, static::OPTIONAL => true],
'description' => [static::TYPE => LocalizedString::class, static::OPTIONAL => true],
'initial' => [static::TYPE => 'bool', static::OPTIONAL => true],
'transitions' => [static::TYPE => StateReferenceCollection::class, static::OPTIONAL => true],
'roles' => [static::TYPE => 'array', static::OPTIONAL => true],
];
}
/**
* @param $key
* @param Context|callable $context
* @return StateDraft
*/
public static function ofKey($key, $context = null)
{
return static::ofKeyAndType($key, self::TYPE_LINE_ITEM_STATE, $context);
}
/**
* @param string $key
* @param string $type
* @param Context|callable $context
* @return StateDraft
*/
public static function ofKeyAndType($key, $type, $context = null)
{
return static::of($context)->setKey($key)->setType($type);
}
}