TYPO3\CMS\Extensionmanager\Utility\Repository\Helper Class Reference

Inheritance diagram for TYPO3\CMS\Extensionmanager\Utility\Repository\Helper:

Public Member Functions
	__construct ()
	setRepository (Repository $repository)
	fetchExtListFile ()
	fetchMirrorListFile ()
string	getLocalExtListFile ()
string	getRemoteExtListFile ()
string	getRemoteExtHashFile ()
string	getLocalMirrorListFile ()
string	getRemoteMirrorListFile ()
Mirrors	getMirrors ($forcedUpdateFromRemote=true)
int	isExtListUpdateNecessary ()
bool	updateExtList ()

Public Attributes
const	PROBLEM_EXTENSION_FILE_NOT_EXISTING = 1
const	PROBLEM_EXTENSION_HASH_CHANGED = 2
const	PROBLEM_NO_VERSIONS_IN_DATABASE = 4

Protected Member Functions
	fetchFile ($remoteResource, $localResource)

Protected Attributes
Repository	$repository
ExtensionRepository	$extensionRepository
ObjectManager	$objectManager

Detailed Description

Central utility class for repository handling.

This class is a specific ExtensionManager implementation and is not part of the Public TYPO3 API.

Definition at line 36 of file Helper.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::__construct

(

)

Definition at line 78 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\$repository, and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\setRepository().

Member Function Documentation

fetchExtListFile()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::fetchExtListFile

(

)

Method fetches extension list file from remote server.

Delegates to fetchFile().

Exceptions

ExtensionManagerException

See also

‪fetchFile()

Definition at line 110 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchFile(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getLocalExtListFile(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getRemoteExtListFile().

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\updateExtList().

fetchFile()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::fetchFile (   $remoteResource,   $localResource  )

protected

Method fetches contents from remote server and writes them into a file in the local file system.

Parameters

string	$remoteResource	‪remote resource to read contents from
string	$localResource	‪local resource (absolute file path) to store retrieved contents to (must be within typo3temp/)

See also

‪\TYPO3\CMS\Core\Utility\GeneralUtility::getUrl()

‪\TYPO3\CMS\Core\Utility\GeneralUtility::writeFile()

Exceptions

ExtensionManagerException

Definition at line 138 of file Helper.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFileToTypo3tempDir().

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchExtListFile(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchMirrorListFile().

fetchMirrorListFile()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::fetchMirrorListFile

(

)

Method fetches mirror list file from remote server.

Delegates to fetchFile().

Exceptions

ExtensionManagerException

See also

‪fetchFile()

Definition at line 123 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchFile(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getLocalMirrorListFile(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getRemoteMirrorListFile().

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getMirrors().

getLocalExtListFile()

string TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getLocalExtListFile

(

)

Method returns location of local extension list file.

Returns

‪string local location of file

See also

‪getRemoteExtListFile()

Definition at line 162 of file Helper.php.

References TYPO3\CMS\Core\Core\Environment\getVarPath().

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchExtListFile(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\isExtListUpdateNecessary(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\updateExtList().

getLocalMirrorListFile()

string TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getLocalMirrorListFile

(

)

Method returns location of local mirror list file.

Returns

‪string local location of file

See also

‪getRemoteMirrorListFile()

Definition at line 199 of file Helper.php.

References TYPO3\CMS\Core\Core\Environment\getVarPath().

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchMirrorListFile(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getMirrors().

getMirrors()

Mirrors TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getMirrors

(

$forcedUpdateFromRemote = true

)

Method returns available mirrors for registered repository.

If there are no mirrors registered to the repository, the method will retrieve them from file system or remote server.

Parameters

bool

$forcedUpdateFromRemote

‪if boolean TRUE, mirror configuration will always retrieved from remote server

Returns

‪Mirrors instance of repository mirrors class

Exceptions

ExtensionManagerException

Definition at line 227 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchMirrorListFile(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getLocalMirrorListFile(), and TYPO3\CMS\Extensionmanager\Domain\Model\Mirrors\getMirrors().

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getRemoteExtHashFile(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getRemoteExtListFile().

getRemoteExtHashFile()

string TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getRemoteExtHashFile

(

)

Method returns location of remote file containing the extension checksum hash.

Returns

‪string remote location of file

Definition at line 186 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Mirrors\getMirror(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getMirrors().

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\isExtListUpdateNecessary().

getRemoteExtListFile()

string TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getRemoteExtListFile

(

)

Method returns location of remote extension list file.

Returns

‪string remote location of file

See also

‪getLocalExtListFile()

Definition at line 173 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Domain\Model\Mirrors\getMirror(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getMirrors().

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchExtListFile().

getRemoteMirrorListFile()

string TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getRemoteMirrorListFile

(

)

Method returns location of remote mirror list file.

Returns

‪string remote location of file

See also

‪getLocalMirrorListFile()

Definition at line 210 of file Helper.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchMirrorListFile().

isExtListUpdateNecessary()

int TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::isExtListUpdateNecessary

(

)

Method returns information if currently available extension list might be outdated.

See also

‪\TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::PROBLEM_NO_VERSIONS_IN_DATABASE

Exceptions

ExtensionManagerException

Returns

‪int "0" if everything is perfect, otherwise bitmask with problems

Definition at line 248 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getLocalExtListFile(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getRemoteExtHashFile(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\PROBLEM_EXTENSION_FILE_NOT_EXISTING, TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\PROBLEM_EXTENSION_HASH_CHANGED, and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\PROBLEM_NO_VERSIONS_IN_DATABASE.

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\updateExtList().

setRepository()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::setRepository

(

Repository

$repository

)

Method registers required repository instance to work with.

Repository instance is passed by reference.

Parameters

Repository

$repository

Definition at line 97 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\$repository.

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\__construct().

updateExtList()

bool TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::updateExtList

(

)

Method updates TYPO3 database with up-to-date extension version records.

Returns

‪bool TRUE if the extension list was successfully update, FALSE if no update necessary

Exceptions

ExtensionManagerException

See also

‪isExtListUpdateNecessary()

Definition at line 281 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchExtListFile(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getLocalExtListFile(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\isExtListUpdateNecessary(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\PROBLEM_EXTENSION_HASH_CHANGED, and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\PROBLEM_NO_VERSIONS_IN_DATABASE.

Member Data Documentation

$extensionRepository

ExtensionRepository TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::$extensionRepository

protected

Definition at line 72 of file Helper.php.

$objectManager

ObjectManager TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::$objectManager

protected

Definition at line 76 of file Helper.php.

$repository

Repository TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::$repository

protected

Keeps instance of repository class.

Definition at line 68 of file Helper.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\__construct(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\setRepository().

PROBLEM_EXTENSION_FILE_NOT_EXISTING

const TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::PROBLEM_EXTENSION_FILE_NOT_EXISTING = 1

Definition at line 49 of file Helper.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\isExtListUpdateNecessary().

PROBLEM_EXTENSION_HASH_CHANGED

const TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::PROBLEM_EXTENSION_HASH_CHANGED = 2

Definition at line 55 of file Helper.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\isExtListUpdateNecessary(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\updateExtList().

PROBLEM_NO_VERSIONS_IN_DATABASE

const TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::PROBLEM_NO_VERSIONS_IN_DATABASE = 4

Definition at line 62 of file Helper.php.

Referenced by TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\isExtListUpdateNecessary(), and TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\updateExtList().