Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • cVersion
  • cVersionFile
  • cVersionLayout
  • cVersionModule
  • Overview
  • Package
  • Class
  • Todo
  • Download

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, object $oDB, integer $iClient, object $sArea, object $iFrame )

The Version object constructor, initializes class variables

The Version object constructor, initializes class variables

Parameters

$aCfg
$aCfgClient
$oDB
$iClient
$sArea
$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.

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
$sValue

Returns

array
returns an array for body node
public boolean
# createNewXml( string $sDirectory, $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
$sFileName name of xml file to create
$sFileName

Returns

boolean
true if saving file was successful, otherwise false
public boolean
# createNewVersion( )

This function creates new version in right folder.

This function creates new version in right folder.

Returns

boolean
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( $sFirstFile = '' )

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

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

Returns

boolean
return true if successful
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( $sKey, $sValue )

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
# 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
The name of Table_Form class
$sAddHeader
The Header Label of SelectBox Widget
$sLabelOfSelectBox
The Label of SelectBox Widget
$sIdOfSelectBox
Id of Select Box
$disabled

If true, show disabled buttons for deleting return string if is exists Revision, then returns HTML Code of full SelectBox else returns empty string

private
# getMessages( )

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

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

private
# getSelectBox( string $aTempVesions, string $sIdOfSelectBox )

A Class Function for fill version files

A Class Function for fill version files

Parameters

$aTempVesions
$sTableForm The name of Table_Form class
$sIdOfSelectBox

$sAddHeader The Header Label of SelectBox Widget return string returns select-box with filled files

public string
# getTextarea( string $sName, string $sInitValue, integer $iWidth, integer $iHeight, boolean $sId = '', $disabled = false )

Build new Textarea with below parameters

Build new Textarea with below parameters

Parameters

$sName
The name of Textarea.
$sInitValue
$sValue The value of Input Textarea
$iWidth
width of Textarea
$iHeight
height of Textarea
$sId
$disabled Disabled Textarea
$disabled

Returns

string
HTML Code of Textarea
public string
# getTextBox( string $sName, string $sInitValue, integer $iWidth, $bDisabled = false )

Build new Textfield with below parameters

Build new Textfield with below parameters

Parameters

$sName
The name of Input Textfield.
$sInitValue
$sValue The value of Input Textfield
$iWidth
width of Input Textfield
$bDisabled

Returns

string
HTML Code of Input Textfield
public
# displayNotification( string $sOutPut )

Displays your notification

Displays your notification

Parameters

$sOutPut
public
# setBodyNodeDescription( string $sDesc )

Set new node for xml file of description

Set new node for xml file of description

Parameters

$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 ??? $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

Database object

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 ??? $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

#
private boolean $bVersioningActive

To take control versioning is switched off

To take control versioning is switched off

#
protected ??? $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

#
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen