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

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

namespace Commercetools\Core\Model\Review;

use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\JsonObject;
use Commercetools\Core\Model\State\StateReference;
use Commercetools\Core\Model\Common\ResourceIdentifier;
use Commercetools\Core\Model\Customer\CustomerReference;
use Commercetools\Core\Model\CustomField\CustomFieldObject;

/**
 * @package Commercetools\Core\Model\Review
 * @link https://docs.commercetools.com/http-api-projects-reviews.html#reviewdraft
 * @method string getKey()
 * @method ReviewDraft setKey(string $key = null)
 * @method string getUniquenessValue()
 * @method ReviewDraft setUniquenessValue(string $uniquenessValue = null)
 * @method string getLocale()
 * @method ReviewDraft setLocale(string $locale = null)
 * @method string getAuthorName()
 * @method ReviewDraft setAuthorName(string $authorName = null)
 * @method string getTitle()
 * @method ReviewDraft setTitle(string $title = null)
 * @method string getText()
 * @method ReviewDraft setText(string $text = null)
 * @method ResourceIdentifier getTarget()
 * @method ReviewDraft setTarget(ResourceIdentifier $target = null)
 * @method StateReference getState()
 * @method ReviewDraft setState(StateReference $state = null)
 * @method int getRating()
 * @method ReviewDraft setRating(int $rating = null)
 * @method CustomerReference getCustomer()
 * @method ReviewDraft setCustomer(CustomerReference $customer = null)
 * @method CustomFieldObject getCustom()
 * @method ReviewDraft setCustom(CustomFieldObject $custom = null)
 */
class ReviewDraft extends JsonObject
{
    public function fieldDefinitions()
    {
        return [
            'key' => [static::TYPE => 'string', static::OPTIONAL => true],
            'uniquenessValue' => [static::TYPE => 'string', static::OPTIONAL => true],
            'locale' => [static::TYPE => 'string', static::OPTIONAL => true],
            'authorName' => [static::TYPE => 'string', static::OPTIONAL => true],
            'title' => [static::TYPE => 'string', static::OPTIONAL => true],
            'text' => [static::TYPE => 'string', static::OPTIONAL => true],
            'target' => [static::TYPE => ResourceIdentifier::class, static::OPTIONAL => true],
            'state' => [static::TYPE => StateReference::class, static::OPTIONAL => true],
            'rating' => [static::TYPE => 'int', static::OPTIONAL => true],
            'customer' => [static::TYPE => CustomerReference::class, static::OPTIONAL => true],
            'custom' => [static::TYPE => CustomFieldObject::class, static::OPTIONAL => true],
        ];
    }

    /**
     * @param string $title
     * @param Context|callable $context
     * @return ReviewDraft
     */
    public static function ofTitle($title, $context = null)
    {
        return static::of($context)->setTitle($title);
    }

    /**
     * @param string $text
     * @param Context|callable $context
     * @return ReviewDraft
     */
    public static function ofText($text, $context = null)
    {
        return static::of($context)->setText($text);
    }

    /**
     * @param int $rating
     * @param Context|callable $context
     * @return ReviewDraft
     */
    public static function ofRating($rating, $context = null)
    {
        return static::of($context)->setRating($rating);
    }

    public function jsonSerialize()
    {
        $data = parent::jsonSerialize();
        if (isset($data['locale'])) {
            $data['locale'] = str_replace('_', '-', $data['locale']);
        }
        return $data;
    }
}

Namespaces

Classes