PHP Class Pimcore\Model\Version

Inheritance: extends AbstractModel
Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$cid integer
$ctype string
$data mixed
$date integer
$disabled boolean
$id integer
$note string
$public boolean
$serialized boolean
$user User
$userId integer

Public Methods

Method Description
cleanHistory ( ) : void the cleanup is now done in the maintenance see self::maintenanceCleanUp()
delete ( ) : void
disable ( ) : void disables the versioning for the current process, this is useful for importers, .
enable ( ) : void see @ self::disable() just enabled the creation of versioning in the current process
getById ( integer $id ) : Version
getCid ( ) : integer
getCtype ( ) : string
getData ( ) : mixed
getDate ( ) : integer
getId ( ) : integer
getNote ( ) : string
getPublic ( ) : boolean
getSerialized ( ) : boolean
getUser ( ) : User
getUserId ( ) : integer
isPublic ( ) : boolean
loadData ( ) : mixed Object
maintenanceCleanUp ( )
maintenanceCompress ( )
save ( ) : void
setCid ( $cid )
setCtype ( string $ctype ) : void
setData ( mixed $data ) : void
setDate ( integer $date )
setId ( integer $id ) : void
setNote ( string $note ) : void
setPublic ( boolean $public ) : void
setSerialized ( boolean $serialized ) : void
setUser ( User $user ) : void
setUserId ( integer $userId ) : void

Protected Methods

Method Description
getBinaryFilePath ( ) : string
getFilePath ( ) : string Returns the path on the file system
getLegacyFilePath ( ) : string

Method Details

cleanHistory() public method

the cleanup is now done in the maintenance see self::maintenanceCleanUp()
Deprecation:
public cleanHistory ( ) : void
return void

delete() public method

public delete ( ) : void
return void

disable() public static method

.. There are no new versions created, the read continues to operate normally
public static disable ( ) : void
return void

enable() public static method

see @ self::disable() just enabled the creation of versioning in the current process
public static enable ( ) : void
return void

getBinaryFilePath() protected method

protected getBinaryFilePath ( ) : string
return string

getById() public static method

public static getById ( integer $id ) : Version
$id integer
return Version

getCid() public method

public getCid ( ) : integer
return integer

getCtype() public method

public getCtype ( ) : string
return string

getData() public method

public getData ( ) : mixed
return mixed

getDate() public method

public getDate ( ) : integer
return integer

getFilePath() protected method

Returns the path on the file system
protected getFilePath ( ) : string
return string

getId() public method

public getId ( ) : integer
return integer

getLegacyFilePath() protected method

protected getLegacyFilePath ( ) : string
return string

getNote() public method

public getNote ( ) : string
return string

getPublic() public method

public getPublic ( ) : boolean
return boolean

getSerialized() public method

public getSerialized ( ) : boolean
return boolean

getUser() public method

public getUser ( ) : User
return User

getUserId() public method

public getUserId ( ) : integer
return integer

isPublic() public method

public isPublic ( ) : boolean
return boolean

loadData() public method

Object
public loadData ( ) : mixed
return mixed

maintenanceCleanUp() public method

public maintenanceCleanUp ( )

maintenanceCompress() public method

public maintenanceCompress ( )

save() public method

public save ( ) : void
return void

setCid() public method

public setCid ( $cid )

setCtype() public method

public setCtype ( string $ctype ) : void
$ctype string
return void

setData() public method

public setData ( mixed $data ) : void
$data mixed
return void

setDate() public method

public setDate ( integer $date )
$date integer

setId() public method

public setId ( integer $id ) : void
$id integer
return void

setNote() public method

public setNote ( string $note ) : void
$note string
return void

setPublic() public method

public setPublic ( boolean $public ) : void
$public boolean
return void

setSerialized() public method

public setSerialized ( boolean $serialized ) : void
$serialized boolean
return void

setUser() public method

public setUser ( User $user ) : void
$user User
return void

setUserId() public method

public setUserId ( integer $userId ) : void
$userId integer
return void

Property Details

$cid public property

public int $cid
return integer

$ctype public property

public string $ctype
return string

$data public property

public mixed $data
return mixed

$date public property

public int $date
return integer

$disabled public static property

public static bool $disabled
return boolean

$id public property

public int $id
return integer

$note public property

public string $note
return string

$public public property

public bool $public
return boolean

$serialized public property

public bool $serialized
return boolean

$user public property

public User,Pimcore\Model $user
return User

$userId public property

public int $userId
return integer