TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extensionmanager\Utility\Repository\Helper Class Reference
Inheritance diagram for TYPO3\CMS\Extensionmanager\Utility\Repository\Helper:
TYPO3\CMS\Core\SingletonInterface

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
 

Detailed Description

Central utility class for repository handling.

Author
Marcus Krause <marcus::exp2010.info>
Steffen Kamper info@.nosp@m.sk-t.nosp@m.ypo3..nosp@m.de

Definition at line 25 of file Helper.php.

Member Function Documentation

◆ fetchExtListFile()

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

Method fetches extension list file from remote server.

Delegates to fetchFile().

public

Returns
void
Exceptions
ExtensionManagerException
See also
fetchFile()

Definition at line 109 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$remoteResourceremote resource to read contents from
string$localResourcelocal resource (absolute file path) to store retrieved contents to
Returns
void
See also
::getUrl(), ::writeFile()
Exceptions
ExtensionManagerException

Definition at line 137 of file Helper.php.

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

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().

public

Returns
void
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\getRemoteMirrorListFile().

◆ getDatabaseConnection()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getDatabaseConnection ( )
protected

Get database connection

Returns

Definition at line 311 of file Helper.php.

References $GLOBALS.

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

◆ getLocalExtListFile()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getLocalExtListFile ( )

Method returns location of local extension list file.

public

Returns
string local location of file
See also
getRemoteExtListFile()

Definition at line 157 of file Helper.php.

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

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getLocalMirrorListFile ( )

Method returns location of local mirror list file.

public

Returns
string local location of file
See also
getRemoteMirrorListFile()

Definition at line 195 of file Helper.php.

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

◆ getRemoteExtHashFile()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getRemoteExtHashFile ( )

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

public

Returns
string remote location of file

Definition at line 182 of file Helper.php.

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

◆ getRemoteExtListFile()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getRemoteExtListFile ( )

Method returns location of remote extension list file.

public

Returns
string remote location of file
See also
getLocalExtListFile()

Definition at line 169 of file Helper.php.

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

◆ getRemoteMirrorListFile()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::getRemoteMirrorListFile ( )

Method returns location of remote mirror list file.

public

Returns
string remote location of file
See also
getLocalMirrorListFile()

Definition at line 207 of file Helper.php.

References TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchMirrorListFile(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\getLocalMirrorListFile(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

◆ isExtListUpdateNecessary()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::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
integer "0" if everything is perfect, otherwise bitmask with problems

Definition at line 246 of file Helper.php.

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

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

◆ setRepository()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::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 95 of file Helper.php.

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

◆ updateExtList()

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::updateExtList ( )

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

Returns
boolean TRUE if the extension list was successfully update, FALSE if no update necessary
Exceptions
ExtensionManagerException
See also
isExtListUpdateNecessary()

Definition at line 275 of file Helper.php.

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

Member Data Documentation

◆ $extensionRepository

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

Definition at line 65 of file Helper.php.

◆ $repository

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::$repository = NULL
protected

Definition at line 55 of file Helper.php.

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

◆ $repositoryRepository

TYPO3\CMS\Extensionmanager\Utility\Repository\Helper::$repositoryRepository
protected

Definition at line 60 of file Helper.php.

◆ PROBLEM_EXTENSION_FILE_NOT_EXISTING

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

Definition at line 37 of file Helper.php.

◆ PROBLEM_EXTENSION_HASH_CHANGED

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

Definition at line 43 of file Helper.php.

◆ PROBLEM_NO_VERSIONS_IN_DATABASE

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

Definition at line 49 of file Helper.php.

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