CONTENIDO_4.9.0 beta1
Back to top  

VersionFile

deprecated [2012-07-02] Use cVersionFile instead of this class.

 Methods

The class versionStyle object constructor, initializes class variables

__construct(string $iIdOfType, array $aFileInfo, $sFileName, $sTypeContent, array $aCfg, array $aCfgClient, object $oDB, int $iClient, string $sArea, int $iFrame, $sVersionFileName) : void

Parameters

$iIdOfType

string

The name of style file

$aFileInfo

array

Get FileInformation from table file_information

$sFileName

$sTypeContent

$aCfg

array

$aCfgClient

array

$oDB

object

$iClient

int

$sArea

string

$iFrame

int

$sVersionFileName

The general SelectBox function for get Revision.

buildSelectBox(string $sTableForm, string $sAddHeader, string $sLabelOfSelectBox, string $sIdOfSelectBox) 
Inherited
inherited_from \cVersion::buildSelectBox()
inherited_from \cVersionFile::buildSelectBox()

Parameters

$sTableForm

string

The name of Table_Form class

$sAddHeader

string

The Header Label of SelectBox Widget

$sLabelOfSelectBox

string

The Label of SelectBox Widget

$sIdOfSelectBox

string

Id of Select Box return string if is exists Revision, then returns HTML Code of full SelectBox else returns empty string

This function creats new version in right folder.

createNewVersion() : void
Inherited
inherited_from \cVersion::createNewVersion()
inherited_from \cVersionFile::createNewVersion()

This function creats an xml file.

createNewXml($sDirectory, string $sFileName) : bool
Inherited

XML Writer helps for create this file.

inherited_from \cVersion::createNewXml()
inherited_from \cVersionFile::createNewXml()

Parameters

$sDirectory

$sFileName

string

name of xml file to create

Returns

booltrue if saving file was successful, otherwise false

This function deletes files and the the folder, for given path.

deleteFile($sFirstFile) : bool
Inherited
inherited_from \cVersion::deleteFile()
inherited_from \cVersionFile::deleteFile()

Parameters

$sFirstFile

Returns

boolreturn true if successful

Displays your notification

displayNotification(string $sOutPut) : void
Inherited
inherited_from \cVersion::displayNotification()
inherited_from \cVersionFile::displayNotification()

Parameters

$sOutPut

string

Get the frontendpath to revision

getFilePath() : string
Inherited
inherited_from \cVersion::getFilePath()
inherited_from \cVersionFile::getFilePath()

Returns

stringreturns path to revision file

This function generate version names for select-box

getFormatTimestamp() : array
Inherited
inherited_from \cVersion::getFormatTimestamp()
inherited_from \cVersionFile::getFormatTimestamp()

Returns

arrayreturns an array of revision file names

Get the last revision file

getLastRevision() : array
Inherited
inherited_from \cVersion::getLastRevision()
inherited_from \cVersionFile::getLastRevision()

Returns

arrayreturns Last Revision

This function reads the path of file

getPathFile() : string
Inherited
inherited_from \cVersionFile::getPathFile()

Returns

stringthe path of file

Revision Files

getRevisionFiles() : array
Inherited
inherited_from \cVersion::getRevisionFiles()
inherited_from \cVersionFile::getRevisionFiles()

Returns

arrayreturns all Revison File

Build new Textfield with below parameters

getTextBox(string $sName, $sInitValue, int $iWidth, $bDisabled) : string
Inherited
inherited_from \cVersion::getTextBox()
inherited_from \cVersionFile::getTextBox()

Parameters

$sName

string

The name of Input Textfield.

$sInitValue

$iWidth

int

width of Input Textfield

$bDisabled

Returns

stringHTML Code of Input Textfield

Build new Textarea with below parameters

getTextarea(string $sName, $sInitValue, int $iWidth, int $iHeight, $sId) : string
Inherited
inherited_from \cVersion::getTextarea()
inherited_from \cVersionFile::getTextarea()

Parameters

$sName

string

The name of Textarea.

$sInitValue

$iWidth

int

width of Textarea

$iHeight

int

height of Textarea

$sId

Returns

stringHTML Code of Textarea

This function read an xml file nodes

initXmlReader(string $sPath) : \{array}
Inherited
inherited_from \cVersionFile::initXmlReader()

Parameters

$sPath

string

Path to file

Returns

\{array}returns array width nodes

Function returns javascript which refreshes CONTENIDO frames for file list an subnavigation.

renderReloadScript(string $sArea, string $sFilename, object $sess) : string
Inherited

This is neccessary, if filenames where changed, when a history entry is restored

inherited_from \cVersionFile::renderReloadScript()

Parameters

$sArea

string
  • name of CONTENIDO area in which this procedure should be done

$sFilename

string
  • new filename of file which should be updated in other frames

$sess

object
  • CONTENIDO session object

Returns

string- Javascript for refrehing frames

Set new node for xml file of description

setBodyNodeDescription(string $sDesc) 
Inherited
inherited_from \cVersion::setBodyNodeDescription()
inherited_from \cVersionFile::setBodyNodeDescription()

Parameters

$sDesc

string

Content of node

This function initialize the body node of xml file

setData(string $sKey, string $sValue) : array
Inherited
inherited_from \cVersion::setData()
inherited_from \cVersionFile::setData()

Parameters

$sKey

string

$sValue

string

Returns

arrayreturns an array for body node

This function generate version names for select-box

setVarForm($sKey, $sValue) : array
Inherited
inherited_from \cVersion::setVarForm()
inherited_from \cVersionFile::setVarForm()

Parameters

$sKey

$sValue

Returns

arrayreturns an array of revision file names

This function checks if needed version paths exists and were created if neccessary

checkPaths() : void
Inherited
inherited_from \cVersion::checkPaths()
inherited_from \cVersionFile::checkPaths()

Inits the first element of revision files

getFirstRevision() : string
Inherited
inherited_from \cVersion::getFirstRevision()
inherited_from \cVersionFile::getFirstRevision()

Returns

stringthe name of xml files

This function init the class member sCode with current file content

initFileContent() : void
Inherited
inherited_from \cVersionFile::initFileContent()

This function inits version files.

initRevisions() : array
Inherited

Its filter also timestamp and version files

inherited_from \cVersion::initRevisions()
inherited_from \cVersionFile::initRevisions()

Returns

arrayreturns xml file names

This function looks if maximum number of stored versions is achieved.

prune() : void
Inherited

If true, it will be delete the first version.

inherited_from \cVersion::prune()
inherited_from \cVersionFile::prune()

Messagebox for build selectBox.

getMessages() 
Inherited

Dynamic allocation for type. return array the attributes alt and poput returns

inherited_from \cVersion::getMessages()
inherited_from \cVersionFile::getMessages()

Makes new and init Revision Name

getRevision() : integer
Inherited
inherited_from \cVersion::getRevision()
inherited_from \cVersionFile::getRevision()

Returns

integerreturns number of Revison File

A Class Function for fill version files

getSelectBox($aTempVesions, $sIdOfSelectBox) 
Inherited
inherited_from \cVersion::getSelectBox()
inherited_from \cVersionFile::getSelectBox()

Parameters

$aTempVesions

$sIdOfSelectBox

 Properties

 

$aRevisionFiles : array
Inherited
inherited_from \cVersion::$$aRevisionFiles
inherited_from \cVersionFile::$$aRevisionFiles
 

$iDisplayNotification : int
Inherited
inherited_from \cVersion::$$iDisplayNotification
inherited_from \cVersionFile::$$iDisplayNotification
 

$sCode 
Inherited
access public
inherited_from \cVersionFile::$$sCode
 

$sDescripion 
Inherited

Its not required to use it.

access protected
inherited_from \cVersionFile::$$sDescripion
 

$sFileName 
Inherited
access public
inherited_from \cVersionFile::$$sFileName
 

$sPath 
Inherited
access public
inherited_from \cVersionFile::$$sPath
 

$aBodyData : string
Inherited
inherited_from \cVersion::$$aBodyData
inherited_from \cVersionFile::$$aBodyData
 

$aCfg : array
Inherited
inherited_from \cVersion::$$aCfg
inherited_from \cVersionFile::$$aCfg
 

$aCfgClient : array
Inherited
inherited_from \cVersion::$$aCfgClient
inherited_from \cVersionFile::$$aCfgClient
 

$aVarForm : array
Inherited
inherited_from \cVersion::$$aVarForm
inherited_from \cVersionFile::$$aVarForm
 

$dActualTimestamp : \???
Inherited
inherited_from \cVersion::$$dActualTimestamp
inherited_from \cVersionFile::$$dActualTimestamp
 

$dCreated : \???
Inherited
inherited_from \cVersion::$$dCreated
inherited_from \cVersionFile::$$dCreated
 

$dLastModified : \???
Inherited
inherited_from \cVersion::$$dLastModified
inherited_from \cVersionFile::$$dLastModified
 

$dTimestamp : \???
Inherited
inherited_from \cVersion::$$dTimestamp
inherited_from \cVersionFile::$$dTimestamp
 

$iClient : int
Inherited
inherited_from \cVersion::$$iClient
inherited_from \cVersionFile::$$iClient
 

$iFrame : int
Inherited
inherited_from \cVersion::$$iFrame
inherited_from \cVersionFile::$$iFrame
 

$iIdentity : int
Inherited
inherited_from \cVersion::$$iIdentity
inherited_from \cVersionFile::$$iIdentity
 

$iRevisionNumber : int
Inherited
inherited_from \cVersion::$$iRevisionNumber
inherited_from \cVersionFile::$$iRevisionNumber
 

$oDB : \cDb
Inherited
inherited_from \cVersion::$$oDB
inherited_from \cVersionFile::$$oDB
 

$sAlternativePath : string
Inherited
inherited_from \cVersion::$$sAlternativePath
inherited_from \cVersionFile::$$sAlternativePath
 

$sArea : array
Inherited
inherited_from \cVersion::$$sArea
inherited_from \cVersionFile::$$sArea
 

$sAuthor : string
Inherited
inherited_from \cVersion::$$sAuthor
inherited_from \cVersionFile::$$sAuthor
 

$sType : string
Inherited
inherited_from \cVersion::$$sType
inherited_from \cVersionFile::$$sType
 

$bVersioningActive : bool
Inherited
inherited_from \cVersion::$$bVersioningActive
inherited_from \cVersionFile::$$bVersioningActive