contenido\classes\class.versionFile.php

Show:

inherited

Classes
- \VersionFile

Table of Contents

Project: Contenido Content Management System

Description: Class of File System We use super class Version to create a new Version.

Requirements:

Author: Bilal Arslan, Timo Trautmann
Con_php_req: 5.0
Copyright: four for business AG
License: http://www.contenido.org/license/LIZENZ.txt
Link: http://www.4fb.de
Link: http://www.contenido.org
Package: Contenido Backend classes
Since: file available since contenido release >= 4.8.8 {@internal created 2008-08-05 }}
Version: 1.0.0

\VersionFile
jump to top

Package: Default

Parent(s): \Version

Properties

$aBodyData

inherited

Body data of xml file

Inherited from: \Version::$$aBodyData

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$aBodyData

$aCfg

inherited

For init global variable

Inherited from: \Version::$$aCfg

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$aCfg

$aCfgClient

inherited

For init global variable $cfgClient

Inherited from: \Version::$$aCfgClient

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$aCfgClient

$aRevisionFiles

inherited

Revision files of current file

Inherited from: \Version::$$aRevisionFiles

Details

Type: n/a
Access: public
Inherited_from: \Version::$$aRevisionFiles

$aVarForm

inherited

For init variables

Inherited from: \Version::$$aVarForm

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$aVarForm

$bVersionCreatActive

inherited

To take control versioning is switched off

Inherited from: \Version::$$bVersionCreatActive

Details

Type: n/a
Access: private
Inherited_from: \Version::$$bVersionCreatActive

$dActualTimestamp

inherited

Timestamp

Inherited from: \Version::$$dActualTimestamp

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$dActualTimestamp

$dCreated

inherited

Time of created

Inherited from: \Version::$$dCreated

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$dCreated

$dLastModified

inherited

Time of last modified

Inherited from: \Version::$$dLastModified

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$dLastModified

$dTimestamp

inherited

Timestamp

Inherited from: \Version::$$dTimestamp

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$dTimestamp

$iClient

inherited

For init global variable $client

Inherited from: \Version::$$iClient

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$iClient

$iDisplayNotification

staticinherited

Displays Notification only onetimes per object

Inherited from: \Version::$$iDisplayNotification

Details

Type: n/a
Inherited_from: \Version::$$iDisplayNotification

$iFrame

inherited

For init global variable $frame

Inherited from: \Version::$$iFrame

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$iFrame

$iIdentity

inherited

Identity the Id of Content Type

Inherited from: \Version::$$iIdentity

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$iIdentity

$iRevisionNumber

inherited

Number of Revision

Inherited from: \Version::$$iRevisionNumber

Details

Type: n/a
Access: private
Inherited_from: \Version::$$iRevisionNumber

$oDB

inherited

Database object

Inherited from: \Version::$$oDB

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$oDB

$sAlternativePath

inherited

Alternative Path for save version files

Inherited from: \Version::$$sAlternativePath

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$sAlternativePath

$sArea

inherited

For init global variable $area

Inherited from: \Version::$$sArea

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$sArea

$sAuthor

inherited

md5 coded name of author

Inherited from: \Version::$$sAuthor

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$sAuthor

$sCode

Content code of current file.

Details

Type: n/a
Access: public

$sDescripion

Description folder of history sub nav.

Its not required to use it.

Details

Type: n/a
Access: protected

$sFileName

The id of Type.

Details

Type: n/a
Access: public

$sPath

The path of style file.

Details

Type: n/a
Access: public

$sType

inherited

Id of Type

Inherited from: \Version::$$sType

Details

Type: n/a
Access: protected
Inherited_from: \Version::$$sType

Methods

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

The class versionStyle object constructor, initializes class variables

Parameters

Name	Type	Description
$iIdOfType	string	The name of style file
$aFileInfo	array	Get FileInformation from table file_information
$sFileName
$sTypeContent
$aCfg	array
$aCfgClient	array
$oDB	object
$iClient	integer
$sArea	object
$iFrame	object
$sVersionFileName

buildSelectBox(string $sTableForm, string $sAddHeader, string $sLabelOfSelectBox, string $sIdOfSelectBox) : void

inherited

The general SelectBox function for get Revision.

Inherited from: \Version::buildSelectBox()

Parameters

Name	Type	Description
$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

checkPaths() : void

inherited

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

Inherited from: \Version::checkPaths()

createNewVersion() : void

inherited

This function creats new version in right folder.

Inherited from: \Version::createNewVersion()

createNewXml() : string

inherited

This function creats an xml file.

Inherited from: \Version::createNewXml()

XML Writer helps for create this file.

Returns

Type	Description
string	returns content of xml file

deleteFile( $sFirstFile = "") : bool

inherited

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

Inherited from: \Version::deleteFile()

Parameters

Name	Type	Description
$sFirstFile

Returns

Type	Description
bool	return true if successful

displayNotification(string $sOutPut) : void

inherited

Displays your notification

Inherited from: \Version::displayNotification()

Parameters

Name	Type	Description
$sOutPut	string

getFilePath() : string

inherited

Get the frontendpath to revision

Inherited from: \Version::getFilePath()

Returns

Type	Description
string	returns path to revision file

getFirstRevision() : string

inherited

Inits the first element of revision files

Inherited from: \Version::getFirstRevision()

Returns

Type	Description
string	the name of xml files

getFormatTimestamp() : array

inherited

This function generate version names for select-box

Inherited from: \Version::getFormatTimestamp()

Returns

Type	Description
array	returns an array of revision file names

getLastRevision() : array

inherited

Get the last revision file

Inherited from: \Version::getLastRevision()

Returns

Type	Description
array	returns Last Revision

getMessages() : void

inherited

Messagebox for build selectBox.

Inherited from: \Version::getMessages()

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

getPathFile() : string

This function reads the path of file

Returns

Type	Description
string	the path of file

getRevision() : integer

inherited

Makes new and init Revision Name

Inherited from: \Version::getRevision()

Returns

Type	Description
integer	returns number of Revison File

getRevisionFiles() : array

inherited

Revision Files

Inherited from: \Version::getRevisionFiles()

Returns

Type	Description
array	returns all Revison File

getSelectBox( $aTempVesions, $sIdOfSelectBox) : void

inherited

A Class Function for fill version files

Inherited from: \Version::getSelectBox()

Parameters

Name	Type	Description
$aTempVesions
$sIdOfSelectBox

getTextBox(string $sName, $sInitValue, integer $iWidth, $bDisabled = false) : string

inherited

Build new Textfield with below parameters

Inherited from: \Version::getTextBox()

Parameters

Name	Type	Description
$sName	string	The name of Input Textfield.
$sInitValue
$iWidth	integer	width of Input Textfield
$bDisabled

Returns

Type	Description
string	HTML Code of Input Textfield

getTextarea(string $sName, $sInitValue, integer $iWidth, integer $iHeight, $sId = "") : string

inherited

Build new Textarea with below parameters

Inherited from: \Version::getTextarea()

Parameters

Name	Type	Description
$sName	string	The name of Textarea.
$sInitValue
$iWidth	integer	width of Textarea
$iHeight	integer	height of Textarea
$sId

Returns

Type	Description
string	HTML Code of Textarea

initFileContent() : void

This function init the class member sCode with current file content

initRevisions() : array

inherited

This function inits version files.

Inherited from: \Version::initRevisions()

Its filter also timestamp and version files

Returns

Type	Description
array	returns xml file names

initXmlReader(string $sPath) : \{array}

This function read an xml file nodes

Parameters

Name	Type	Description
$sPath	string	Path to file

Returns

Type	Description
\{array}	returns array width nodes

prune() : void

inherited

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

Inherited from: \Version::prune()

If true, it will be delete the first version.

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

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

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

Parameters

Name	Type	Description
$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

Type	Description
string	- Javascript for refrehing frames

setBodyNodeDescription(string $sDesc) : void

inherited

Set new node for xml file of description

Inherited from: \Version::setBodyNodeDescription()

Parameters

Name	Type	Description
$sDesc	string	Content of node

setData(string $sKey, string $sValue) : array

inherited

This function initialize the body node of xml file

Inherited from: \Version::setData()

Parameters

Name	Type	Description
$sKey	string
$sValue	string

Returns

Type	Description
array	returns an array for body node

setVarForm( $sKey, $sValue) : array

inherited

This function generate version names for select-box

Inherited from: \Version::setVarForm()

Parameters

Name	Type	Description
$sKey
$sValue

Returns

Type	Description
array	returns an array of revision file names

contenido\classes\class.versionFile.php

\VersionFilejump to top

Properties

Methods

\VersionFile
jump to top