Public Member Functions
	__construct (string $url, string $subject, string $version, string $cache_dir)

	check (string $version, bool $nocache=false)

	getVersionInfo (bool $nocache=false)

	getVersion ()

	getFileURL ()

	getInfoURL ()

	getChecksum ()

	getPHPVersion ()

	getWarning ()

	getNotify ()

	getForcedFiles ()

	setForcedFiles (... $args)

	setNotify ($n)

	checkIntegrity (string $digests_file, string $root)

	getBadFiles ()

	download (string $dest)

	checkDownload (string $zip)

	backup (string $zip_file, string $zip_digests, string $root, string $root_digests, string $dest)

	performUpgrade (string $zip_file, string $zip_digests, string $zip_root, string $root, string $root_digests)

Data Fields
const	ERR_FILES_CHANGED = 101

const	ERR_FILES_UNREADABLE = 102

const	ERR_FILES_UNWRITALBE = 103

Protected Member Functions
	getNewFiles (array $cur_digests, array $new_digests)

	readVersion (string $str)

	md5sum (string $root, string $digests_file)

	parseLine (&$v, $k, $n)

Static Protected Member Functions
static	md5_check (string $filename, string $md5)

Protected Attributes
	$url

	$subject

	$version

	$cache_file

	$version_info

	$cache_ttl = '-6 hours'

	$forced_files = []

	$bad_files = []

Constructor & Destructor Documentation

◆ __construct()

__construct	(	string	$url,
		string	$subject,
		string	$version,
		string	$cache_dir
	)

Constructor

Parameters

string	$url	Versions file URL
string	$subject	Subject to check
string	$version	Version channel
string	$cache_dir	Directory cache path

References $subject, $url, and $version.

Member Function Documentation

◆ check()

check	(	string	$version,
		bool	$nocache = `false`
	)

Checks for Dotclear updates. Returns latest version if available or false.

Parameters

string	$version	Current version to compare
bool	$nocache	Force checking

Returns: mixed Latest version if available

References $version, getVersion(), and getVersionInfo().

◆ getVersionInfo()

getVersionInfo ( bool $nocache = false )

Gets the version information.

Parameters

bool $nocache The no cache flag

Exceptions

Exception

Returns: mixed

References DC_QUERY_TIMEOUT, and readVersion().

Referenced by check().

◆ getVersion()

getVersion ( )

Gets the version.

Returns: string|null The version.

Referenced by check().

◆ getFileURL()

getFileURL ( )

Gets the file url.

Returns: string|null The file url.

Referenced by download().

◆ getInfoURL()

getInfoURL ( )

Gets the information url.

Returns: string|null The information url.

◆ getChecksum()

getChecksum ( )

Gets the checksum.

Returns: string|null The checksum.

Referenced by checkDownload().

◆ getPHPVersion()

getPHPVersion ( )

Gets the php version.

Returns: string|null The php version.

◆ getWarning()

getWarning ( )

Gets the warning flag.

Returns: bool The warning.

◆ getNotify()

getNotify ( )

Gets the notify flag.

Returns: bool The notify.

◆ getForcedFiles()

getForcedFiles ( )

Gets the forced files.

Returns: array The forced files.

References $forced_files.

◆ setForcedFiles()

setForcedFiles ( $args )

Sets the forced files.

Parameters

mixed ...$args The arguments

◆ setNotify()

setNotify ( $n )

Sets the notify flag.

Parameters

mixed $n The new value

◆ checkIntegrity()

checkIntegrity	(	string	$digests_file,
		string	$root
	)

Check integrity

Parameters

string	$digests_file	The digests file
string	$root	The root

Exceptions

Exception If some files have changed

Returns: bool

References md5sum().

◆ getBadFiles()

getBadFiles ( )

Gets the bad files.

Returns: array The bad files.

References $bad_files.

◆ download()

download ( string $dest )

Downloads new version to destination.

Parameters

string $dest The destination

Exceptions

Exception

References $url, DC_QUERY_TIMEOUT, and getFileURL().

◆ checkDownload()

checkDownload ( string $zip )

Check downloaded file

Parameters

string $zip The zip

Returns: bool

References getChecksum().

◆ backup()

backup	(	string	$zip_file,
		string	$zip_digests,
		string	$root,
		string	$root_digests,
		string	$dest
	)

Backups changed files before an update.

Parameters

string	$zip_file	The zip file
string	$zip_digests	The zip digests
string	$root	The root
string	$root_digests	The root digests
string	$dest	The destination

Exceptions

Exception

Returns: bool

References getNewFiles().

◆ performUpgrade()

performUpgrade	(	string	$zip_file,
		string	$zip_digests,
		string	$zip_root,
		string	$root,
		string	$root_digests
	)

Performs an upgrade.

Parameters

string	$zip_file	The zip file
string	$zip_digests	The zip digests
string	$zip_root	The zip root
string	$root	The root
string	$root_digests	The root digests

Exceptions

Exception

References getNewFiles().

◆ getNewFiles()

getNewFiles	(	array	$cur_digests,
		array	$new_digests
	)

protected

Gets the new files.

Parameters

array	$cur_digests	The current digests
array	$new_digests	The new digests

Returns: array The new files.

Referenced by backup(), and performUpgrade().

◆ readVersion()

readVersion ( string $str )

protected

Reads a version information from string.

Parameters

string $str The string

Referenced by getVersionInfo().

◆ md5sum()

md5sum	(	string	$root,
		string	$digests_file
	)

protected

Return list of changed files

Parameters

string	$root	The root
string	$digests_file	The digests file

Exceptions

Exception

Returns: array

Referenced by checkIntegrity().

◆ parseLine()

parseLine	(	&	$v,
			$k,
			$n
	)

protected

Parse digests file line

Parameters

mixed	$v	The value
mixed	$k	The key/index
mixed	$n	array_walk() 3rd arg

◆ md5_check()

static md5_check	(	string	$filename,
		string	$md5
	)

staticprotected

Check the MD5 of a file

Parameters

string	$filename	The filename
string	$md5	The MD5 checksum

Returns: bool

Field Documentation

◆ ERR_FILES_CHANGED

const ERR_FILES_CHANGED = 101

Referenced by adminUpdate\process().

◆ ERR_FILES_UNREADABLE

const ERR_FILES_UNREADABLE = 102

Referenced by adminUpdate\process().

◆ ERR_FILES_UNWRITALBE

const ERR_FILES_UNWRITALBE = 103

Referenced by adminUpdate\process().

◆ $url

$url

protected

Referenced by __construct(), and download().

◆ $subject

$subject

protected

Referenced by __construct().

◆ $version

$version

protected

Referenced by __construct(), and check().

◆ $cache_file

$cache_file

protected

◆ $version_info

$version_info

protected

Initial value:

= [
        'version'  => null,
        'href'     => null,
        'checksum' => null,
        'info'     => null,
        'php'      => '7.4',
        'warning'  => false,
        'notify'   => true,
    ]

◆ $cache_ttl

$cache_ttl = '-6 hours'

protected

◆ $forced_files

$forced_files = []

protected

Referenced by getForcedFiles().

◆ $bad_files

$bad_files = []

protected

Referenced by getBadFiles().

The documentation for this class was generated from the following file:

inc/core/class.dc.update.php

Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ check()

◆ getVersionInfo()

◆ getVersion()

◆ getFileURL()

◆ getInfoURL()

◆ getChecksum()

◆ getPHPVersion()

◆ getWarning()

◆ getNotify()

◆ getForcedFiles()

◆ setForcedFiles()

◆ setNotify()

◆ checkIntegrity()

◆ getBadFiles()

◆ download()

◆ checkDownload()

◆ backup()

◆ performUpgrade()

◆ getNewFiles()

◆ readVersion()

◆ md5sum()

◆ parseLine()

◆ md5_check()

Field Documentation

◆ ERR_FILES_CHANGED

◆ ERR_FILES_UNREADABLE

◆ ERR_FILES_UNWRITALBE

◆ $url

◆ $subject

◆ $version

◆ $cache_file

◆ $version_info

◆ $cache_ttl

◆ $forced_files

◆ $bad_files