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

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

namespace Commercetools\Core\Model\CustomField;

use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\JsonObject;
use Commercetools\Core\Model\Type\TypeReference;
use Commercetools\Core\Model\Common\ResourceIdentifier;

/**
 * @package Commercetools\Core\Model\CustomField
 * @link https://docs.commercetools.com/http-api-projects-custom-fields.html#customfieldsdraft
 * @method FieldContainer getFields()
 * @method CustomFieldObjectDraft setFields(FieldContainer $fields = null)
 * @method TypeReference getType()
 * @method CustomFieldObjectDraft setType(TypeReference $type = null)
 */
class CustomFieldObjectDraft extends CustomFieldObject
{
    public function fieldDefinitions()
    {
        return [
            'type' => [static::TYPE => TypeReference::class],
            'fields' => [static::TYPE => FieldContainer::class, static::OPTIONAL => true]
        ];
    }

    /**
     * @param string $typeKey
     * @param Context|callable $context
     * @return CustomFieldObjectDraft
     */
    public static function ofTypeKey($typeKey, $context = null)
    {
        $draft = static::of($context)->setType(TypeReference::ofKey($typeKey));

        return $draft;
    }

    /**
     * @param string $typeKey
     * @param FieldContainer $fields
     * @param Context|callable $context
     * @return CustomFieldObjectDraft
     */
    public static function ofTypeKeyAndFields($typeKey, FieldContainer $fields, $context = null)
    {
        return static::of($context)
            ->setType(TypeReference::ofKey($typeKey))
            ->setFields($fields);
    }

    /**
     * @param string $typeId
     * @param Context|callable $context
     * @return CustomFieldObjectDraft
     */
    public static function ofTypeId($typeId, $context = null)
    {
        $draft = static::of($context)->setType(TypeReference::ofId($typeId));

        return $draft;
    }

    /**
     * @param TypeReference $type
     * @param Context|callable $context
     * @return CustomFieldObjectDraft
     */
    public static function ofType(TypeReference $type, $context = null)
    {
        $draft = static::of($context)->setType($type);

        return $draft;
    }

    /**
     * @param TypeReference $type
     * @param FieldContainer $fields
     * @param Context|callable $context
     * @return CustomFieldObjectDraft
     */
    public static function ofTypeAndFields(TypeReference $type, FieldContainer $fields, $context = null)
    {
        return static::of($context)
            ->setType($type)
            ->setFields($fields);
    }
}

Namespaces

Classes