contenido\classes\class.update.notifier.php

Show: inherited

• Classes
  • \Contenido_UpdateNotifier

Table of Contents

Author

Dominik Ziegler  

Con_php_req

5.0  

Con_php_req

simplexml  

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.7 {@internal created 2008-06-21 modified 2008-07-01 timo trautmann - added rss update functionality modified 2008-07-02, Dominik Ziegler, added language support for rss modified 2009-10-01, Dominik Ziegler, added some checks for directory write permissions modified 2010-10-01, Dominik Ziegler, added resource check of fsockopen stream modified 2011-03-18, Murat Purc, fixed thrown errors while invalid socket handles, see [CON-366] $Id: class.update.notifier.php 1331 2011-03-18 22:14:29Z xmurrix $: }}  

Version

1.0.2  

\Contenido_UpdateNotifier

jump to top

Package: Default

Properties

array $aCfg = array()

Contenido configuration array

Default valuearray()Details

Type

array

Access

protected  

array $aPropConf = array("itemType" => "update", "itemID" => 1, "type" => "file_check", "name" => "xml")

Property configuration array

Default valuearray("itemType" => "update", "itemID" => 1, "type" => "file_check", "name" => "xml")Details

Type

array

Access

protected  

array $aSysPropConf = array("type" => "update", "name" => "check")

System property configuration array for update notification

Default valuearray("type" => "update", "name" => "check")Details

Type

array

Access

protected  

array $aSysPropConfPeriod = array("type" => "update", "name" => "check_period")

System property configuration array for update period

Default valuearray("type" => "update", "name" => "check_period")Details

Type

array

Access

protected  

array $aSysPropConfRss = array("type" => "update", "name" => "news_feed")

System property configuration array for rss notification

Default valuearray("type" => "update", "name" => "news_feed")Details

Type

array

Access

protected  

boolean $bEnableCheck = false

Check for system setting

Default valuefalseDetails

Type

boolean

Access

protected  

boolean $bEnableCheckRss = false

Check for system setting Rss

Default valuefalseDetails

Type

boolean

Access

protected  

boolean $bEnableView = false

Display update notification based on user rights (sysadmin only)

Default valuefalseDetails

Type

boolean

Access

protected  

boolean $bNoWritePermissions = false

If true contenido displays a special error message due to missing write permissions.

Default valuefalseDetails

Type

boolean

Access

protected  

boolean $bUpdateNecessity = false

Update necessity

Default valuefalseDetails

Type

boolean

Access

protected  

integer $iCacheDuration = 60

Cache duration in minutes

Default value60Details

Type

integer

Access

protected  

integer $iConnectTimeout = 3

Timeout for the fsockopen connection

Default value3Details

Type

integer

Access

protected  

object $oProperties = null

Properties object

Default valuenullDetails

Type

object

Access

protected  

object $oSession = null

Session object

Default valuenullDetails

Type

object

Access

protected  

object $oXML = null

SimpleXML object

Default valuenullDetails

Type

object

Access

protected  

string $sBackendLanguage = ""

Current backend language

Default value""Details

Type

string

Access

protected  

string $sCacheDirectory = ""

Contains the cache path.

Default value""Details

Type

string

Access

protected  

string $sMinorRelease = ""

Minor release for the simplexml xpath() method

Default value""Details

Type

string

Access

protected  

string $sRSSContent = ""

Content of the language specific RSS file

Default value""Details

Type

string

Access

protected  

string $sRSSFile = ""

Language specific RSS file

Default value""Details

Type

string

Access

protected  

string $sTimestampCacheFile = "update.txt"

Timestamp cache file

Default value"update.txt"Details

Type

string

Access

protected  

string $sVendorHost = "www.contenido.org"

Host for vendor XML

Default value"www.contenido.org"Details

Type

string

Access

protected  

string $sVendorHostPath = "con_version_check_feeds/"

Path to files

Default value"con_version_check_feeds/"Details

Type

string

Access

protected  

string $sVendorRssDeFile = "rss_de.xml"

German Vendor RSS file

Default value"rss_de.xml"Details

Type

string

Access

protected  

string $sVendorRssEnFile = "rss_en.xml"

English Vendor RSS file

Default value"rss_en.xml"Details

Type

string

Access

protected  

string $sVendorURL = "http://www.contenido.org/de/redir"

Download URL

Default value"http://www.contenido.org/de/redir"Details

Type

string

Access

protected  

string $sVendorVersion = ""

Current available vendor version

Default value""Details

Type

string

Access

protected  

string $sVendorXMLFile = "vendor.xml"

Vendor XML file

Default value"vendor.xml"Details

Type

string

Access

protected  

string $sXMLContent = ""

Content of the XML file

Default value""Details

Type

string

Access

protected  

Methods

__construct( $aCfg,  $oUser,  $oPerm,  $oSession,  $sBackendLanguage) : void

Constructor of Contenido_UpdateNotifier

Parameters

Name	Type	Description
$aCfg
$oUser
$oPerm
$oSession
$sBackendLanguage

Details

Access

public  

checkPatchLevel() : string

Checks the patch level of system and vendor version

Returns

Type	Description
string

Details

Access

protected  

checkUpdateNecessity() : void

Checks if the xml files must be loaded from the vendor host or local cache

Details

Access

protected  

detectMinorRelease() : void

Detects and converts the minor release of the system version

Details

Access

protected  

displayOutput() : string

Displays the rendered output

Returns

Type	Description
string

Details

Access

public  

getDownloadURL() : string

Generates the download URL

Returns

Type	Description
string

Details

Access

protected  

getHashProperty() : string

Gets the xml file hash from the property table

Returns

Type	Description
string

Details

Access

protected  

getVendorHostFiles() : array

Connects with vendor host and gets the xml files

Returns

Type	Description
array

Details

Access

protected  

handleVendorUpdate( $aXMLContent) : void

Handles the update of files coming per vendor host

Parameters

Name	Type	Description
$aXMLContent

Details

Access

protected  

readVendorContent() : void

Reads the xml files from vendor host or cache and checks for file manipulations

Details

Access

protected  

renderOutput( $sMessage) : string

Generates the output for the backend

Parameters

Name	Type	Description
$sMessage		string

Returns

Type	Description
string

Details

Access

protected  

renderRss( $oTpl) : \contenido

Generates the output for the rss informations

Parameters

Name	Type	Description
$oTpl

Returns

Type	Description
\contenido	template object

Details

Access

protected  

setCachePath() : void

Sets the cache path

Details

Access

protected  

setRSSFile() : void

Sets the actual RSS file for the reader

Details

Access

protected  

updateCacheFiles( $aRSSContent) : void

Updates the files in cache

Parameters

Name	Type	Description
$aRSSContent		array

Details

Access

protected  

updateHashProperty( $aXMLContent) : void

Updates the xml file hash in the property table

Parameters

Name	Type	Description
$aXMLContent

Details

Access

protected  

updateSystemProperty( $sAction) : void

Updates the system property for activation/deactivation requests

Parameters

Name	Type	Description
$sAction		string

Details

Access

protected