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
$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

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

createNew($versionComments)

No description

approve($doReindexImmediately = true, $scheduleDatetime = null)

No description

discard()

No description

canDiscard()

No description

removeNewStatus()

No description

deny()

No description

delete()

No description

clearPublishDates()

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 131
CategoryInterface getObjectAttributeCategory()

No description

Return Value

CategoryInterface

at line 138
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 45
getPermissionObjectIdentifier()

No description

at line 50
getPermissionResponseClassName()

No description

at line 55
getPermissionAssignmentClassName()

No description

at line 60
getPermissionObjectKeyCategoryHandle()

No description

at line 65
refreshCache()

No description

at line 82
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 160
isApproved()

No description

at line 165
getPublishDate()

No description

at line 170
isMostRecent()

No description

at line 182
isNew()

No description

at line 187
getVersionID()

No description

at line 192
getCollectionID()

No description

at line 197
getVersionName()

No description

at line 202
getVersionComments()

No description

at line 207
getVersionAuthorUserID()

No description

at line 212
getVersionApproverUserID()

No description

at line 217
getVersionAuthorUserName()

No description

at line 229
getVersionApproverUserName()

No description

at line 241
getCustomAreaStyles()

No description

at line 264
string getVersionDateCreated()

Gets the date the collection version was created.

Return Value

string

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

at line 269
setComment($comment)

No description

Parameters

$comment

at line 285
setPublishDate($publishDate)

No description

Parameters

$publishDate

at line 301
createNew($versionComments)

No description

Parameters

$versionComments

at line 402
approve($doReindexImmediately = true, $scheduleDatetime = null)

No description

Parameters

$doReindexImmediately
$scheduleDatetime

at line 504
discard()

No description

at line 534
canDiscard()

No description

at line 551
removeNewStatus()

No description

at line 562
deny()

No description

at line 593
delete()

No description

at line 655
private clearPublishDates()

No description