Class cVersion

Base version class

Direct known subclasses

cVersionFile, cVersionLayout, cVersionModule

Package: Core\Versioning
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Bilal Arslan, Timo Trautmann
Located at classes/version/class.version.php

Methods summary
`public`	# `__construct( array $aCfg, array $aCfgClient, cDb $oDB, integer $iClient, string $sArea, integer $iFrame )` Constructor to create an instance of this class. Constructor to create an instance of this class. Initializes class variables. Parameters `$aCfg` `array` $aCfg `$aCfgClient` `array` $aCfgClient `$oDB` `cDb` $oDB CONTENIDO database object `$iClient` `integer` $iClient `$sArea` `string` $sArea `$iFrame` `integer` $iFrame
`protected`	# `prune( )` This function looks if maximum number of stored versions is achieved. If true, it will be delete the first version. This function looks if maximum number of stored versions is achieved. If true, it will be delete the first version. Throws `cInvalidArgumentException`
`protected`	# `checkPaths( )` This function checks if needed version paths exists and were created if necessary This function checks if needed version paths exists and were created if necessary
`public array`	# `setData( string $sKey, string $sValue )` This function initialize the body node of xml file This function initialize the body node of xml file Parameters `$sKey` `string` $sKey `$sValue` `string` $sValue Returns `array` returns an array for body node
`public boolean`	# `createNewXml( string $sDirectory, string $sFileName )` This function creats an xml file. XML Writer helps for create this file. This function creats an xml file. XML Writer helps for create this file. Parameters `$sDirectory` `string` $sDirectory `$sFileName` `string` $sFileName name of xml file to create Returns `boolean` true if saving file was successful, otherwise false Throws `cException`
`public boolean`	# `createNewVersion( )` This function creates new version in right folder. This function creates new version in right folder. Returns `boolean` Throws `cException` if new version could not be created
`protected array`	# `initRevisions( )` This function inits version files. Its filter also timestamp and version files This function inits version files. Its filter also timestamp and version files Returns `array` returns xml file names
`public boolean`	# `deleteFile( string $sFirstFile = '' )` This function deletes files and the the folder, for given path. This function deletes files and the the folder, for given path. Parameters `$sFirstFile` `string` $sFirstFile [optional] Returns `boolean` return true if successful Throws `cInvalidArgumentException`
`public string`	# `getFilePath( )` Get the frontendpath to revision Get the frontendpath to revision Returns `string` returns path to revision file
`public array`	# `getLastRevision( )` Get the last revision file Get the last revision file Returns `array` returns Last Revision
`private integer`	# `getRevision( )` Makes new and init Revision Name Makes new and init Revision Name Returns `integer` returns number of Revison File
`protected string`	# `getFirstRevision( )` Inits the first element of revision files Inits the first element of revision files Returns `string` the name of xml files
`public array`	# `getRevisionFiles( )` Revision Files Revision Files Returns `array` returns all Revison File
`public array`	# `getFormatTimestamp( )` This function generate version names for select-box This function generate version names for select-box Returns `array` returns an array of revision file names
`public array`	# `setVarForm( string $sKey, string $sValue )` This function generate version names for select-box This function generate version names for select-box Parameters `$sKey` `string` $sKey `$sValue` `string` $sValue Returns `array` returns an array of revision file names
`public string`	# `buildSelectBox( string $sTableForm, string $sAddHeader, string $sLabelOfSelectBox, string $sIdOfSelectBox, boolean $disabled = false )` The general SelectBox function for get Revision. The general SelectBox function for get Revision. Parameters `$sTableForm` `string` $sTableForm The name of Table_Form class `$sAddHeader` `string` $sAddHeader The Header Label of SelectBox Widget `$sLabelOfSelectBox` `string` $sLabelOfSelectBox The Label of SelectBox Widget `$sIdOfSelectBox` `string` $sIdOfSelectBox Id of Select Box `$disabled` `boolean` $disabled [optional] If true, show disabled buttons for deleting Returns `string` if is exists Revision, then returns HTML Code of full SelectBox else returns empty string Throws `cInvalidArgumentException`
`private array`	# `getMessages( )` Messagebox for build selectBox. Dynamic allocation for type. Messagebox for build selectBox. Dynamic allocation for type. Returns `array` the attributes alt and poput returns
`private string`	# `getSelectBox( string $aTempVesions, string $sIdOfSelectBox )` A Class Function for fill version files A Class Function for fill version files Parameters `$aTempVesions` `string` $sTableForm The name of Table_Form class `$sIdOfSelectBox` `string` $sAddHeader The Header Label of SelectBox Widget Returns `string` returns select-box with filled files
`public string`	# `getTextarea( string $sName, string $sInitValue, integer $iWidth, integer $iHeight, string $sId = '', boolean $disabled = false )` Build new Textarea with below parameters Build new Textarea with below parameters Parameters `$sName` `string` $sName The name of Textarea. `$sInitValue` `string` $sInitValue The value of Input Textarea `$iWidth` `integer` $iWidth width of Textarea `$iHeight` `integer` $iHeight height of Textarea `$sId` `string` $sId [optional] `$disabled` `boolean` $disabled [optional] Disabled Textarea Returns `string` HTML Code of Textarea
`public string`	# `getTextBox( string $sName, string $sInitValue, integer $iWidth, boolean $bDisabled = false )` Build new Textfield with below parameters Build new Textfield with below parameters Parameters `$sName` `string` $sName The name of Input Textfield. `$sInitValue` `string` $sInitValue The value of Input Textfield `$iWidth` `integer` $iWidth width of Input Textfield `$bDisabled` `boolean` $bDisabled [optional] Disabled TextBox Returns `string` HTML Code of Input Textfield
`public`	# `displayNotification( string $sOutPut )` Displays your notification Displays your notification Parameters `$sOutPut` `string` $sOutPut
`public`	# `setBodyNodeDescription( string $sDesc )` Set new node for xml file of description Set new node for xml file of description Parameters `$sDesc` `string` $sDesc Content of node

Properties summary
`protected string`	`$sType`	# Id of Type Id of Type
`protected string`	`$sAuthor`	# md5 coded name of author md5 coded name of author
`protected ???`	`$dCreated`	# Time of created Time of created
`protected unknown_type`	`$dLastModified`	# Time of last modified Time of last modified
`protected string`	`$aBodyData`	# Body data of xml file Body data of xml file
`protected array`	`$aCfg`	# For init global variable For init global variable
`protected array`	`$aCfgClient`	# For init global variable $cfgClient For init global variable $cfgClient
`protected cDb`	`$oDB`	# CONTENIDO database object CONTENIDO database object
`protected integer`	`$iClient`	# For init global variable $client For init global variable $client
`public array`	`$aRevisionFiles`	# Revision files of current file Revision files of current file
`protected integer`	`$iRevisionNumber`	# Number of Revision Number of Revision
`protected array`	`$dTimestamp`	# Timestamp Timestamp
`protected array`	`$sArea`	# For init global variable $area For init global variable $area
`protected integer`	`$iFrame`	# For init global variable $frame For init global variable $frame
`protected array`	`$aVarForm`	# For init variables For init variables
`protected integer`	`$iIdentity`	# Identity the Id of Content Type Identity the Id of Content Type
`protected string`	`$sDescripion`	#
`protected string`	`$iVersion`	#
`private boolean`	`$bVersioningActive`	# To take control versioning is switched off To take control versioning is switched off
`protected integer`	`$dActualTimestamp`	# Timestamp Timestamp
`protected string`	`$sAlternativePath`	# Alternative Path for save version files Alternative Path for save version files
`public static integer`	`$iDisplayNotification`	# Displays Notification only onetimes per object Displays Notification only onetimes per object

Packages

Classes

Class cVersion

Direct known subclasses

Parameters

Throws

Parameters

Returns

Parameters

Returns

Throws

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters