class Version extends ConcreteObject implements ObjectInterface, ObjectInterface (View source)

Traits

Properties

$error from  ConcreteObject
$cvID
$cvIsApproved
$cvIsNew
$cvHandle
$cvName
$cvDescription
$cvDateCreated
$cvDatePublic
$pTemplateID
$cvAuthorUID
$cvApproverUID
$cvComments
$pThemeID
$cvPublishDate
$cvPublishEndDate
$cvDateApproved
$cID
protected $attributes
$layoutStyles
protected $isMostRecent
protected $customAreaStyles

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

getAttributeValueObject(AttributeKeyInterface|string $ak, bool $createIfNotExists = false)

No description

getAttribute($ak, $mode = false)

No description

Value
getAttributeValue($ak)

No description

clearAttribute($ak)

No description

Value
setAttribute($ak, mixed $value)

Sets the attribute of a user info object to the specified value, and saves it in the database.

refreshCache()

No description

static Version
get(Collection $c, int|string $cvID)

Get a Version instance given the Collection and a version identifier.

isApproved()

No description

getPublishDate()

No description

getPublishEndDate()

No description

isMostRecent()

No description

isNew()

No description

getVersionID()

No description

getCollectionID()

No description

getVersionName()

No description

getVersionComments()

No description

getVersionAuthorUserID()

No description

getVersionApproverUserID()

No description

getVersionAuthorUserName()

No description

getVersionApproverUserName()

No description

getCustomAreaStyles()

No description

string
getVersionDateCreated()

Gets the date the collection version was created.

null|string
getVersionDateApproved()

Gets the date the collection version was approved.

setComment($comment)

No description

setPublishDate($publishDate)

No description

setPublishEndDate($publishEndDate)

No description

createNew($versionComments)

No description

approve($doReindexImmediately = true, $cvPublishDate = null, $cvPublishEndDate = null)

No description

discard()

No description

canDiscard()

No description

removeNewStatus()

No description

deny()

No description

delete()

No description

clearPublishStartDate()

No description

clearPublishEndDate()

No description

Details

loadError($error)

No description

Parameters

$error

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

Parameters

$arr

static camelcase($file)

No description

Parameters

$file

static uncamelcase($string)

No description

Parameters

$string

CategoryInterface getObjectAttributeCategory()

No description

Return Value

CategoryInterface

AttributeValueInterface|null getAttributeValueObject(AttributeKeyInterface|string $ak, bool $createIfNotExists = false)

No description

Parameters

AttributeKeyInterface|string $ak

An attribute key instance (or its handle)

bool $createIfNotExists

Shall the generic attribute value be created if it does not already exist?

Return Value

AttributeValueInterface|null

getAttribute($ak, $mode = false)

No description

Parameters

$ak
$mode

Value getAttributeValue($ak)

No description

Parameters

$ak

Return Value

Value

clearAttribute($ak)

No description

Parameters

$ak

Value setAttribute($ak, mixed $value)

Sets the attribute of a user info object to the specified value, and saves it in the database.

Parameters

$ak
mixed $value

Return Value

Value

getPermissionObjectIdentifier()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

refreshCache()

No description

static Version get(Collection $c, int|string $cvID)

Get a Version instance given the Collection and a version identifier.

Parameters

Collection $c

The collection for which you want the version.

int|string $cvID

The specific version ID (or 'ACTIVE', 'SCHEDULED', 'RECENT').

Return Value

Version

isApproved()

No description

getPublishDate()

No description

getPublishEndDate()

No description

isMostRecent()

No description

isNew()

No description

getVersionID()

No description

getCollectionID()

No description

getVersionName()

No description

getVersionComments()

No description

getVersionAuthorUserID()

No description

getVersionApproverUserID()

No description

getVersionAuthorUserName()

No description

getVersionApproverUserName()

No description

getCustomAreaStyles()

No description

string getVersionDateCreated()

Gets the date the collection version was created.

Return Value

string

date formated like: 2009-01-01 00:00:00

null|string getVersionDateApproved()

Gets the date the collection version was approved.

Return Value

null|string

date formated like: 2009-01-01 00:00:00

setComment($comment)

No description

Parameters

$comment

setPublishDate($publishDate)

No description

Parameters

$publishDate

setPublishEndDate($publishEndDate)

No description

Parameters

$publishEndDate

createNew($versionComments)

No description

Parameters

$versionComments

approve($doReindexImmediately = true, $cvPublishDate = null, $cvPublishEndDate = null)

No description

Parameters

$doReindexImmediately
$cvPublishDate
$cvPublishEndDate

discard()

No description

canDiscard()

No description

removeNewStatus()

No description

deny()

No description

delete()

No description

private clearPublishStartDate()

No description

private clearPublishEndDate()

No description