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
int|string deprecated $cvID
bool|int|string deprecated $cvIsApproved
bool|int|string deprecated $cvIsNew
string|null $cvHandle

The collection version handle.
string|null deprecated $cvName
string|null $cvDescription

The collection version description.
string|null deprecated $cvDateCreated
string|null $cvDatePublic

The date/time when this collection version was made public.
int|string $pTemplateID

The ID of the page template.
int|string|null deprecated $cvAuthorUID
int|string|null deprecated $cvApproverUID
string|null deprecated $cvComments
int|string $pThemeID

The ID of the page theme.
string $pThemeSkinIdentifier

The identifier of any custom skin attached to this page version.
string|null deprecated $cvPublishDate
string|null deprecated $cvPublishEndDate
string|null deprecated $cvDateApproved
int deprecated $cID
protected $attributes
$layoutStyles
protected bool|null $isMostRecent

Is this the most recent version?
protected array|null $customAreaStyles

The custom area style IDs.

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, bool $doReindexImmediately = true)

No description

from  ObjectTrait
Value
setAttribute($ak, mixed $value, bool $doReindexImmediately = true)

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()

Clear the cache for this collection.

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

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

bool|int|string
isApproved()

Is this version approved?

bool
isApprovedNow($when = null)

Is this version approved and in the publish interval?

string|null
getPublishDate()

Get the scheduled date/time when the collection is published: start.

string|null
getPublishEndDate()

Get the scheduled date/time when the collection is published: end.

bool
isMostRecent()

Is this the most recent version?

bool|number|string
isNew()

Is this a new version?

int|string
getVersionID()

Get the collection version ID.

int
getCollectionID()

Get the collection ID.

string|null
getVersionName()

The collection version name.

string|null
getVersionComments($sanitize = true)

Get the collection version comments.

int|string|null
getVersionAuthorUserID()

Get the ID of the user that created this collection version.

int|string|null
getVersionApproverUserID()

Get the ID of the user that approved this collection version.

string|null|false
getVersionAuthorUserName()

Get the name of the user that approved this collection version.

string|null|false
getVersionApproverUserName()

Get the name of the user that approved this collection version.

array
getCustomAreaStyles()

Get the custom area style IDs.

string|null
getVersionDateCreated()

Get the date/time when the collection version was created.

string|null
getVersionDateApproved()

Get the date the collection version was approved.

setComment(string $comment)

Set the collection version comments.

setPublishDate(string|DateTime|int|null $publishDate)

Set the scheduled date/time when the collection is published: start.

setPublishEndDate(string|DateTime|int|null $publishEndDate)

Set the scheduled date/time when the collection is published: end.

setPublishInterval(string|DateTime|int|null $startDateTime, string|DateTime|int|null $endDateTime)

Set the scheduled date/time when the collection is published.

Version
createNew(string $versionComments)

Create a new version for the same collection as this collection version.

approve(bool $doReindexImmediately = true, string|DateTime|int|null $cvPublishDate = null, string|DateTime|int|null $cvPublishEndDate = null, bool $keepOtherScheduling = false)

Approve this collection version.

discard()

Discard my most recent edit that is pending.

bool
canDiscard()

Check if this collection version can be discarded.

removeNewStatus()

Mark this collection version as not new.

void
updateCollectionDateModified()

No description

void
deny()

Mark this collection version as not approved.

delete()

Delete this version and its related data (blocks, attributes, custom styles, ...).

avoidApprovalOverlapping()

Make sure that other collection versions aren't approved and valid at the same time as this version.

Details

in ConcreteObject at line 11
loadError($error)

No description

Parameters

$error

in ConcreteObject at line 16
isError()

No description

in ConcreteObject at line 26
getError()

No description

in ConcreteObject at line 31
setPropertiesFromArray($arr)

No description

Parameters

$arr

in ConcreteObject at line 38
static camelcase($file)

No description

Parameters

$file

in ConcreteObject at line 43
static uncamelcase($string)

No description

Parameters

$string

at line 319
CategoryInterface getObjectAttributeCategory()

No description

Return Value

CategoryInterface

See also

ObjectInterface::getObjectAttributeCategory

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

See also

ObjectInterface::getAttributeValueObject

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

No description

Parameters

$ak
$mode

in ObjectTrait at line 38
Value getAttributeValue($ak)

No description

Parameters

$ak

Return Value

Value

in ObjectTrait at line 50
clearAttribute($ak, bool $doReindexImmediately = true)

No description

Parameters

$ak
bool $doReindexImmediately

in ObjectTrait at line 74
Value setAttribute($ak, mixed $value, bool $doReindexImmediately = true)

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

Parameters

$ak
mixed $value
bool $doReindexImmediately

Return Value

Value

at line 188
getPermissionObjectIdentifier()

No description

See also

ObjectInterface::getPermissionObjectIdentifier

at line 198
getPermissionResponseClassName()

No description

See also

ObjectInterface::getPermissionResponseClassName

at line 208
getPermissionAssignmentClassName()

No description

See also

ObjectInterface::getPermissionAssignmentClassName

at line 218
getPermissionObjectKeyCategoryHandle()

No description

See also

ObjectInterface::getPermissionObjectKeyCategoryHandle

at line 226
refreshCache()

Clear the cache for this collection.

at line 243
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 362
bool|int|string isApproved()

Is this version approved?

Return Value

bool|int|string

See also

isApprovedNow()

at line 373
bool isApprovedNow($when = null)

Is this version approved and in the publish interval?

Parameters

$when

Return Value

bool

at line 407
string|null getPublishDate()

Get the scheduled date/time when the collection is published: start.

Return Value

string|null

Examples

'2018-21-31 23:59:59'

at line 419
string|null getPublishEndDate()

Get the scheduled date/time when the collection is published: end.

Return Value

string|null

Examples

'2018-21-31 23:59:59'

at line 429
bool isMostRecent()

Is this the most recent version?

Return Value

bool

at line 446
bool|number|string isNew()

Is this a new version?

Return Value

bool|number|string

at line 456
int|string getVersionID()

Get the collection version ID.

Return Value

int|string

at line 466
int getCollectionID()

Get the collection ID.

Return Value

int

at line 476
string|null getVersionName()

The collection version name.

Return Value

string|null

at line 486
string|null getVersionComments($sanitize = true)

Get the collection version comments.

Parameters

$sanitize

Return Value

string|null

at line 496
int|string|null getVersionAuthorUserID()

Get the ID of the user that created this collection version.

Return Value

int|string|null

at line 506
int|string|null getVersionApproverUserID()

Get the ID of the user that approved this collection version.

Return Value

int|string|null

at line 516
string|null|false getVersionAuthorUserName()

Get the name of the user that approved this collection version.

Return Value

string|null|false

return NULL if there's no author, false if it has been deleted, or a string otherwise

at line 533
string|null|false getVersionApproverUserName()

Get the name of the user that approved this collection version.

Return Value

string|null|false

return NULL if there's no author, false if it has been deleted, or a string otherwise

at line 550
array getCustomAreaStyles()

Get the custom area style IDs.

Return Value

array

key: area handle, value: the inline stle set ID

at line 575
string|null getVersionDateCreated()

Get the date/time when the collection version was created.

Return Value

string|null

Examples

'2018-21-31 23:59:59'

at line 587
string|null getVersionDateApproved()

Get the date the collection version was approved.

Return Value

string|null

Examples

'2018-21-31 23:59:59'

at line 597
setComment(string $comment)

Set the collection version comments.

Parameters

string $comment

at line 620
setPublishDate(string|DateTime|int|null $publishDate)

Set the scheduled date/time when the collection is published: start.

Parameters

string|DateTime|int|null $publishDate

the scheduled date/time when the collection is published (start)

Exceptions

UserMessageException

at line 632
setPublishEndDate(string|DateTime|int|null $publishEndDate)

Set the scheduled date/time when the collection is published: end.

Parameters

string|DateTime|int|null $publishEndDate

the scheduled date/time when the collection is published (end)

Exceptions

UserMessageException

at line 645
setPublishInterval(string|DateTime|int|null $startDateTime, string|DateTime|int|null $endDateTime)

Set the scheduled date/time when the collection is published.

Parameters

string|DateTime|int|null $startDateTime

the scheduled date/time when the collection is published (start)
string|DateTime|int|null $endDateTime

the scheduled date/time when the collection is published (end)

Exceptions

UserMessageException

at line 677
Version createNew(string $versionComments)

Create a new version for the same collection as this collection version.

Parameters

string $versionComments

the new collection version comments

Return Value

Version

at line 706
approve(bool $doReindexImmediately = true, string|DateTime|int|null $cvPublishDate = null, string|DateTime|int|null $cvPublishEndDate = null, bool $keepOtherScheduling = false)

Since: 9.0.0 Added $keepOtherScheduling argument

Approve this collection version.

Parameters

bool $doReindexImmediately

reindex the collection contents now? Otherwise it's reindexing will just be scheduled
string|DateTime|int|null $cvPublishDate

the scheduled date/time when the collection is published (start)
string|DateTime|int|null $cvPublishEndDate

the scheduled date/time when the collection is published (end)
bool $keepOtherScheduling

Set to true to keep scheduling of other versions (e.g., users can view the current live version until the publish date of this version). Set to false (default) to disapprove all other versions (e.g., users can't see this page until the publish date of this version, even if this page is live now).

Exceptions

UserMessageException

at line 824
discard()

Discard my most recent edit that is pending.

at line 858
bool canDiscard()

Check if this collection version can be discarded.

Return Value

bool

at line 878
removeNewStatus()

Mark this collection version as not new.

at line 889
private void updateCollectionDateModified()

No description

Return Value

void

at line 909
void deny()

Mark this collection version as not approved.

Return Value

void

at line 938
delete()

Delete this version and its related data (blocks, attributes, custom styles, ...).

at line 1004
private avoidApprovalOverlapping()

Make sure that other collection versions aren't approved and valid at the same time as this version.