Docs For Class CollectionVersion

Description

An object that maps to versions of collections. Each page in concrete is a _collection_ of blocks, each of which has different versions (for version control.)

author: Andrew Embler <andrew@concrete5.org>
copyright: Copyright (c) 2003-2008 Concrete5. (http://www.concrete5.org)
license: MIT License

Located in /models/collection_version.php (line 22)

Object
   |
   --CollectionVersion

Variable Summary

mixed $attributes

mixed $cID

mixed $customAreaStyles

mixed $cvIsApproved

mixed $layoutStyles

Method Summary

static void getNumericalVersionID ( $cID, $cvID)

void approve ()

void canWrite ()

void createNew ( $versionComments)

void delete ()

void deny ()

void discard ()

void get ( &$c, $cvID)

void getAttribute ( $ak)

void getVersionApproverUserID ()

void getVersionApproverUserName ()

void getVersionAuthorUserID ()

void getVersionAuthorUserName ()

void getVersionComments ()

string getVersionDateCreated ([string $type = 'system'])

void getVersionID ()

void getVersionName ()

void isApproved ()

void isMostRecent ()

void isNew ()

void refreshCache ()

void removeNewStatus ()

void setComment ( $comment)

void _checkRecent ()

Variables

mixed $attributes = array() (line 26)

access: protected

mixed $cID (line 25)

mixed $customAreaStyles = array() (line 27)

access: public

mixed $cvIsApproved (line 24)

mixed $layoutStyles = array() (line 28)

access: public

Methods

static getNumericalVersionID (line 33)

Returns the actual cvID numerical value for a particular cID/cvID combo

access: public

void getNumericalVersionID ( $cID, $cvID)

$cID
$cvID

approve (line 224)

void approve ()

canWrite (line 167)

void canWrite ()

createNew (line 180)

void createNew ( $versionComments)

$versionComments

delete (line 298)

void delete ()

deny (line 277)

void deny ()

discard (line 261)

access: public

void discard ()

get (line 83)

access: public

void get ( &$c, $cvID)

&$c
$cvID

getAttribute (line 125)

access: public

void getAttribute ( $ak)

$ak

getVersionApproverUserID (line 138)

void getVersionApproverUserID ()

getVersionApproverUserName (line 145)

void getVersionApproverUserName ()

getVersionAuthorUserID (line 137)

void getVersionAuthorUserID ()

getVersionAuthorUserName (line 139)

void getVersionAuthorUserName ()

getVersionComments (line 136)

void getVersionComments ()

getVersionDateCreated (line 158)

Gets the date the collection version was created

if user is specified, returns in the current user's timezone

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

string getVersionDateCreated ([string $type = 'system'])

string $type: (system || user)

getVersionID (line 134)

void getVersionID ()

getVersionName (line 135)

void getVersionName ()

isApproved (line 131)

void isApproved ()

isMostRecent (line 132)

void isMostRecent ()

isNew (line 133)

void isNew ()

refreshCache (line 69)

access: public

void refreshCache ()

removeNewStatus (line 271)

access: public

void removeNewStatus ()

setComment (line 169)

void setComment ( $comment)

$comment

_checkRecent (line 212)

void _checkRecent ()