Helper Class Reference

Inheritance diagram for Helper:

Public Member Functions
	setRepository (\TYPO3\CMS\Extensionmanager\Domain\Model\Repository $repository)
	fetchExtListFile ()
	fetchMirrorListFile ()
	getLocalExtListFile ()
	getRemoteExtListFile ()
	getRemoteExtHashFile ()
	getLocalMirrorListFile ()
	getRemoteMirrorListFile ()
	isExtListUpdateNecessary ()
	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)
	getDatabaseConnection ()

Protected Attributes
	$repository = null
	$repositoryRepository
	$extensionRepository
	$configurationUtility

Detailed Description

Central utility class for repository handling.

Definition at line 23 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

Member Function Documentation

fetchExtListFile

(

)

Method fetches extension list file from remote server.

Delegates to fetchFile().

public

Returns

void

Exceptions

ExtensionManagerException

See Also

fetchFile()

Definition at line 115 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

References Helper\fetchFile(), Helper\getLocalExtListFile(), and Helper\getRemoteExtListFile().

Referenced by Helper\updateExtList().

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/)

Returns

void

See Also

::getUrl(), ::writeFile()

Exceptions

ExtensionManagerException

Definition at line 145 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

References GeneralUtility\writeFileToTypo3tempDir().

Referenced by Helper\fetchExtListFile(), and Helper\fetchMirrorListFile().

fetchMirrorListFile

(

)

Method fetches mirror list file from remote server.

Delegates to fetchFile().

public

Returns

void

Exceptions

ExtensionManagerException

See Also

fetchFile()

Definition at line 130 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

References Helper\fetchFile(), Helper\getLocalMirrorListFile(), and Helper\getRemoteMirrorListFile().

getDatabaseConnection ( )

protected

Get database connection

Returns

Definition at line 331 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

References $GLOBALS.

Referenced by Helper\updateExtList().

getLocalExtListFile

(

)

Method returns location of local extension list file.

public

Returns

string local location of file

See Also

getRemoteExtListFile()

Definition at line 169 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

Referenced by Helper\fetchExtListFile(), Helper\isExtListUpdateNecessary(), and Helper\updateExtList().

getLocalMirrorListFile

(

)

Method returns location of local mirror list file.

public

Returns

string local location of file

See Also

getRemoteMirrorListFile()

Definition at line 210 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

Referenced by Helper\fetchMirrorListFile().

getRemoteExtHashFile

(

)

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

public

Returns

string remote location of file

Definition at line 196 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

Referenced by Helper\isExtListUpdateNecessary().

getRemoteExtListFile

(

)

Method returns location of remote extension list file.

public

Returns

string remote location of file

See Also

getLocalExtListFile()

Definition at line 182 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

Referenced by Helper\fetchExtListFile().

getRemoteMirrorListFile

(

)

Method returns location of remote mirror list file.

public

Returns

string remote location of file

See Also

getLocalMirrorListFile()

Definition at line 223 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

Referenced by Helper\fetchMirrorListFile().

isExtListUpdateNecessary

(

)

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

public

See Also

Tx_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 264 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

References Helper\getLocalExtListFile(), and Helper\getRemoteExtHashFile().

Referenced by Helper\updateExtList().

setRepository

(

\TYPO3\CMS\Extensionmanager\Domain\Model\Repository

$repository

)

Method registers required repository instance to work with.

Repository instance is passed by reference.

public

Parameters

\TYPO3\CMS\Extensionmanager\Domain\Model\Repository

$repository

Returns

void

See Also

$repository

Definition at line 100 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

References Helper\$repository.

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 294 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

References Helper\fetchExtListFile(), Helper\getDatabaseConnection(), Helper\getLocalExtListFile(), Helper\isExtListUpdateNecessary(), and Helper\PROBLEM_NO_VERSIONS_IN_DATABASE.

Member Data Documentation

$configurationUtility

protected

Definition at line 68 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

$extensionRepository

protected

Definition at line 63 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

$repository = null

protected

Definition at line 53 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

Referenced by Helper\setRepository().

$repositoryRepository

protected

Definition at line 58 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

const PROBLEM_EXTENSION_FILE_NOT_EXISTING = 1

Definition at line 35 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

const PROBLEM_EXTENSION_HASH_CHANGED = 2

Definition at line 41 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

const PROBLEM_NO_VERSIONS_IN_DATABASE = 4

Definition at line 47 of file typo3/sysext/extensionmanager/Classes/Utility/Repository/Helper.php.

Referenced by Helper\updateExtList().