1. class
  2. Concrete
  3. \
  4. Core
  5. \
  6. Page
  7. \
  8. Collection
  9. \
  10. Version
  11. \
  12. Version

Version

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

Traits

ObjectTrait

Properties

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

Methods

loadError($error)

No description

from  ConcreteObject
isError()

No description

from  ConcreteObject
getError()

No description

from  ConcreteObject
setPropertiesFromArray($arr)

No description

from  ConcreteObject
static 
camelcase($file)

No description

from  ConcreteObject
static 
uncamelcase($string)

No description

from  ConcreteObject
CategoryInterface
getObjectAttributeCategory()

No description

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

No description

getAttribute($ak, $mode = false)

No description

from  ObjectTrait
Value
getAttributeValue($ak)

No description

from  ObjectTrait
clearAttribute($ak)

No description

from  ObjectTrait
Value
setAttribute($ak, mixed $value)

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

from  ObjectTrait
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.

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.

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

in ConcreteObject at line 10
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 15
isError()

No description

in ConcreteObject at line 25
getError()

No description

in ConcreteObject at line 30
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 37
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 42
static uncamelcase($string)

No description

Parameters

$string

at line 130
CategoryInterface getObjectAttributeCategory()

No description

Return Value

CategoryInterface

at line 137
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

in ObjectTrait at line 24
getAttribute($ak, $mode = false)

No description

Parameters

$ak
$mode

in ObjectTrait at line 36
Value getAttributeValue($ak)

No description

Parameters

$ak

Return Value

Value

in ObjectTrait at line 47
clearAttribute($ak)

No description

Parameters

$ak

in ObjectTrait at line 68
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

at line 46
getPermissionObjectIdentifier()

No description

at line 51
getPermissionResponseClassName()

No description

at line 56
getPermissionAssignmentClassName()

No description

at line 61
getPermissionObjectKeyCategoryHandle()

No description

at line 66
refreshCache()

No description

at line 83
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

at line 159
isApproved()

No description

at line 164
getPublishDate()

No description

at line 169
getPublishEndDate()

No description

at line 175
isMostRecent()

No description

at line 187
isNew()

No description

at line 192
getVersionID()

No description

at line 197
getCollectionID()

No description

at line 202
getVersionName()

No description

at line 207
getVersionComments()

No description

at line 212
getVersionAuthorUserID()

No description

at line 217
getVersionApproverUserID()

No description

at line 222
getVersionAuthorUserName()

No description

at line 234
getVersionApproverUserName()

No description

at line 246
getCustomAreaStyles()

No description

at line 269
string getVersionDateCreated()

Gets the date the collection version was created.

Return Value

string

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

at line 274
setComment($comment)

No description

Parameters

$comment

at line 290
setPublishDate($publishDate)

No description

Parameters

$publishDate

at line 306
setPublishEndDate($publishEndDate)

No description

Parameters

$publishEndDate

at line 323
createNew($versionComments)

No description

Parameters

$versionComments

at line 424
approve($doReindexImmediately = true, $cvPublishDate = null, $cvPublishEndDate = null)

No description

Parameters

$doReindexImmediately
$cvPublishDate
$cvPublishEndDate

at line 534
discard()

No description

at line 564
canDiscard()

No description

at line 581
removeNewStatus()

No description

at line 592
deny()

No description

at line 623
delete()

No description

at line 685
private clearPublishStartDate()

No description

at line 694
private clearPublishEndDate()

No description