CTP SDK : File Core/Model/Type/TypeDraft.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

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 */

namespace Commercetools\Core\Model\Type;

use Commercetools\Core\Model\Common\JsonObject;
use Commercetools\Core\Model\Common\LocalizedString;

/**
 * @package Commercetools\Core\Model\Type
 * @link https://docs.commercetools.com/http-api-projects-types.html#typedraft
 * @method string getKey()
 * @method TypeDraft setKey(string $key = null)
 * @method LocalizedString getName()
 * @method TypeDraft setName(LocalizedString $name = null)
 * @method LocalizedString getDescription()
 * @method TypeDraft setDescription(LocalizedString $description = null)
 * @method array getResourceTypeIds()
 * @method TypeDraft setResourceTypeIds(array $resourceTypeIds = null)
 * @method FieldDefinitionCollection getFieldDefinitions()
 * @method TypeDraft setFieldDefinitions(FieldDefinitionCollection $fieldDefinitions = null)
 */
class TypeDraft extends JsonObject
{
    public function fieldDefinitions()
    {
        return [
            'key' => [static::TYPE => 'string'],
            'name' => [static::TYPE => LocalizedString::class],
            'description' => [static::TYPE => LocalizedString::class, static::OPTIONAL => true],
            'resourceTypeIds' => [static::TYPE => 'array'],
            'fieldDefinitions' => [static::TYPE => FieldDefinitionCollection::class, static::OPTIONAL => true],
        ];
    }

    public static function ofKeyNameDescriptionAndResourceTypes(
        $key,
        LocalizedString $name,
        LocalizedString $description,
        array $resourceTypeIds,
        $context = null
    ) {
        return static::of($context)
            ->setKey($key)->setName($name)->setDescription($description)->setResourceTypeIds($resourceTypeIds);
    }
}

Namespaces

Classes