Commercetools\Api\Models\Review\ReviewDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\Review\ReviewDraft:

Public Member Functions
	getKey ()
	getUniquenessValue ()
	getLocale ()
	getAuthorName ()
	getTitle ()
	getText ()
	getTarget ()
	getState ()
	getRating ()
	getCustomer ()
	getCustom ()
	setKey (?string $key)
	setUniquenessValue (?string $uniquenessValue)
	setLocale (?string $locale)
	setAuthorName (?string $authorName)
	setTitle (?string $title)
	setText (?string $text)
	setTarget (?JsonObject $target)
	setState (?StateResourceIdentifier $state)
	setRating (?int $rating)
	setCustomer (?CustomerResourceIdentifier $customer)
	setCustom (?CustomFieldsDraft $custom)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_KEY = 'key'
const	FIELD_UNIQUENESS_VALUE = 'uniquenessValue'
const	FIELD_LOCALE = 'locale'
const	FIELD_AUTHOR_NAME = 'authorName'
const	FIELD_TITLE = 'title'
const	FIELD_TEXT = 'text'
const	FIELD_TARGET = 'target'
const	FIELD_STATE = 'state'
const	FIELD_RATING = 'rating'
const	FIELD_CUSTOMER = 'customer'
const	FIELD_CUSTOM = 'custom'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (stdClass $data=null)

Detailed Description

Definition at line 19 of file ReviewDraft.php.

Member Function Documentation

getAuthorName()

Commercetools\Api\Models\Review\ReviewDraft::getAuthorName

(

)

Name of the author.

Returns

null|string

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getCustom()

Commercetools\Api\Models\Review\ReviewDraft::getCustom

(

)

Custom Fields for the Review.

Returns

null|CustomFieldsDraft

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getCustomer()

Commercetools\Api\Models\Review\ReviewDraft::getCustomer

(

)

Customer who created the Review.

Returns

null|CustomerResourceIdentifier

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getKey()

Commercetools\Api\Models\Review\ReviewDraft::getKey

(

)

User-defined unique identifier for the Review.

Returns

null|string

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getLocale()

Commercetools\Api\Models\Review\ReviewDraft::getLocale

(

)

Language in which the content of the Review is written.

Returns

null|string

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getRating()

Commercetools\Api\Models\Review\ReviewDraft::getRating

(

)

Rating of the targeted Product or Channel. This rating can represent the number of stars, a percentage, or a like (+1)/dislike (-1). A rating is used in the ratings statistics of the targeted object, unless the Review is in a State that does not have the role ReviewIncludedInStatistics.

Returns

null|int

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getState()

Commercetools\Api\Models\Review\ReviewDraft::getState

(

)

State of the Review. Used for approval processes, see Review approval process for details.

Returns

null|StateResourceIdentifier

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getTarget()

Commercetools\Api\Models\Review\ReviewDraft::getTarget

(

)

Identifies the target of the Review. Can be a Product or a Channel, specified as ProductResourceIdentifier or ChannelResourceIdentifier, respectively.

Returns

null|mixed

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getText()

Commercetools\Api\Models\Review\ReviewDraft::getText

(

)

Content of the Review.

Returns

null|string

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getTitle()

Commercetools\Api\Models\Review\ReviewDraft::getTitle

(

)

Title of the Review.

Returns

null|string

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

getUniquenessValue()

Commercetools\Api\Models\Review\ReviewDraft::getUniquenessValue

(

)

If set, this value must be unique among Reviews. For example, if you want to have only one Review per Customer and per Product, you can set the value to Customer id + Product id.

Returns

null|string

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setAuthorName()

Commercetools\Api\Models\Review\ReviewDraft::setAuthorName

(

?string

$authorName

)

Parameters

?string

$authorName

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setCustom()

Commercetools\Api\Models\Review\ReviewDraft::setCustom

(

?CustomFieldsDraft

$custom

)

Parameters

?CustomFieldsDraft

$custom

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setCustomer()

Commercetools\Api\Models\Review\ReviewDraft::setCustomer

(

?CustomerResourceIdentifier

$customer

)

Parameters

?CustomerResourceIdentifier

$customer

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setKey()

Commercetools\Api\Models\Review\ReviewDraft::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setLocale()

Commercetools\Api\Models\Review\ReviewDraft::setLocale

(

?string

$locale

)

Parameters

?string

$locale

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setRating()

Commercetools\Api\Models\Review\ReviewDraft::setRating

(

?int

$rating

)

Parameters

?int

$rating

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setState()

Commercetools\Api\Models\Review\ReviewDraft::setState

(

?StateResourceIdentifier

$state

)

Parameters

?StateResourceIdentifier

$state

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setTarget()

Commercetools\Api\Models\Review\ReviewDraft::setTarget

(

?JsonObject

$target

)

Parameters

?JsonObject

$target

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setText()

Commercetools\Api\Models\Review\ReviewDraft::setText

(

?string

$text

)

Parameters

?string

$text

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setTitle()

Commercetools\Api\Models\Review\ReviewDraft::setTitle

(

?string

$title

)

Parameters

?string

$title

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

setUniquenessValue()

Commercetools\Api\Models\Review\ReviewDraft::setUniquenessValue

(

?string

$uniquenessValue

)

Parameters

?string

$uniquenessValue

Implemented in Commercetools\Api\Models\Review\ReviewDraftModel.

Member Data Documentation

FIELD_AUTHOR_NAME

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_AUTHOR_NAME = 'authorName'

Definition at line 24 of file ReviewDraft.php.

FIELD_CUSTOM

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_CUSTOM = 'custom'

Definition at line 31 of file ReviewDraft.php.

FIELD_CUSTOMER

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_CUSTOMER = 'customer'

Definition at line 30 of file ReviewDraft.php.

FIELD_KEY

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_KEY = 'key'

Definition at line 21 of file ReviewDraft.php.

FIELD_LOCALE

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_LOCALE = 'locale'

Definition at line 23 of file ReviewDraft.php.

FIELD_RATING

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_RATING = 'rating'

Definition at line 29 of file ReviewDraft.php.

FIELD_STATE

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_STATE = 'state'

Definition at line 28 of file ReviewDraft.php.

FIELD_TARGET

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_TARGET = 'target'

Definition at line 27 of file ReviewDraft.php.

FIELD_TEXT

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_TEXT = 'text'

Definition at line 26 of file ReviewDraft.php.

FIELD_TITLE

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_TITLE = 'title'

Definition at line 25 of file ReviewDraft.php.

FIELD_UNIQUENESS_VALUE

const Commercetools\Api\Models\Review\ReviewDraft::FIELD_UNIQUENESS_VALUE = 'uniquenessValue'

Definition at line 22 of file ReviewDraft.php.

---

The documentation for this interface was generated from the following file:

• lib/commercetools-api/src/Models/Review/ReviewDraft.php