phpDocumentor GalleryCore
UserInterface
[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]

Class: AdminRepositoryDownloadAndInstallController

Source Location: /modules/core/classes/AdminRepositoryDownloadAndInstallController.class

Class AdminRepositoryDownloadAndInstallController

Direct descendents
Child Class Description
AdminRepositoryDownloadAndInstallControllerTestWrapper
AdminRepositoryController This controller will handle an administration request for a module
AdminRepositoryDownloadController This controller will handle an administration request for a module
AdminLanguageManagerController This controller will handle an administration request to add, update or remove a language.

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GalleryController

GalleryController::assertIsGenuineRequest()
Verifies the genuineness of the request
GalleryController::getItem()
Return the current item, as specified in the itemId request variable.
GalleryController::handleRequest()
Take the appropriate action based on the user input provided.
GalleryController::isAllowedInEmbedOnly()
Does this controller allow direct access even in embed-only mode?
GalleryController::isAllowedInMaintenance()
Does this controller allow access to non-admins when site is in maintenance mode?
GalleryController::loadController()
Load a controller
GalleryController::omitAuthTokenCheck()
Whether the controller opts-out from the framework's auth token check.
GalleryController::permissionCheck()
GalleryController::shouldSaveSession()
Should session be saved and session cookie sent when this controller is used?

[ Top ]
Method Summary
GalleryStatus   performDownloadAndInstallation()   Download specified packages to the local repository cache and perform installation.
GalleryStatus   updatePluginStatus()   Update the repository index, and scan all installed plugins and update GalleryPluginPackageMap with a complete listing of everything that's installed.
int   _countInstallActions()   Calculate the total number of actions for the progress notifications
array   _createDownloadFileList()   Create a list of all the files that need to be downloaded
void   _fetchPluginStatus()   Passthrough to GalleryCoreApi::fetchPluginStatus, used by test code to allow us to inject mock plugins.
GalleryStatus   _synchronizeLanguages()   Synchronize the active language packages with the newly downloaded packages

[ Top ]
Methods
performDownloadAndInstallation  [line 48]

  GalleryStatus performDownloadAndInstallation( array $installPackages, mixed $repositories  )

Download specified packages to the local repository cache and perform installation.

Parameters:
array   $installPackages:  packages to install

API Tags:
Return:  a status code


[ Top ]
updatePluginStatus  [line 318]

  GalleryStatus updatePluginStatus( array $pluginStatus, array $repositories, array $redirect  )

Update the repository index, and scan all installed plugins and update GalleryPluginPackageMap with a complete listing of everything that's installed.

Parameters:
array   $pluginStatus:  status of all available installed plugins
array   $repositories:  the repositories available for new plugins
array   $redirect:  generateUrl params defining the view to return to

API Tags:
Return:  a status code

Information Tags:
Todo:  Show a summary page (or at least a link to it) which contains details about the exact tasks that were performed and any errors that were encountered.

[ Top ]
_countInstallActions  [line 241]

  int _countInstallActions( array $sourcedFiles  )

Calculate the total number of actions for the progress notifications

Parameters:
array   $sourcedFiles:  list of files that were downloaded

API Tags:
Return:  number of actions


[ Top ]
_createDownloadFileList  [line 217]

  array _createDownloadFileList( array $installPackages, array $repositories  )

Create a list of all the files that need to be downloaded

Parameters:
array   $installPackages:  packages to install
array   $repositories:  an array of GalleryRepository

API Tags:
Return:  GalleryStatus a status code array list of corresponding files for the specified packages


[ Top ]
_fetchPluginStatus  [line 302]

  void _fetchPluginStatus( $pluginType, $ignoreCache  )

Passthrough to GalleryCoreApi::fetchPluginStatus, used by test code to allow us to inject mock plugins.

Parameters:
   $pluginType: 
   $ignoreCache: 

API Tags:
Access:  protected
See:  GalleryCoreApi::fetchPluginStatus


Redefined in descendants as:

[ Top ]
_synchronizeLanguages  [line 266]

  GalleryStatus _synchronizeLanguages( array $sourcedFiles, &$callback, array $callback  )

Synchronize the active language packages with the newly downloaded packages

Parameters:
array   $sourcedFiles:  list of files that were downloaded
array   $callback:  progress notification callback
   &$callback: 

API Tags:
Return:  a status code


[ Top ]

Documentation generated on Fri, 08 Oct 2010 04:36:14 -0700 by phpDocumentor 1.3.0RC6