[ Index ]
 

Code source de SugarCRM 5.0.0beta1

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/ModuleInstall/PackageManager/ -> PackageManagerComm.php (sommaire)

(pas de description)

Poids: 319 lignes (13 kb)
Inclus ou requis: 1 fois
Référencé: 1 fois
Nécessite: 4 fichiers
 include/nusoap/nusoap.php
 sugar_version.php
 config.php
 ModuleInstall/PackageManager/PackageManagerDownloader.php

Définit 1 class

PackageManagerComm:: (19 méthodes):
  initialize()
  errorCheck()
  setCredentials()
  clearSession()
  login()
  logout()
  getPromotion()
  getCategoryPackages()
  getCategories()
  getPackages()
  getReleases()
  download()
  addDownload()
  performDownload()
  getDocumentation()
  getTermsAndConditions()
  downloadedDocumentation()
  checkForUpdates()
  isAlive()


Classe: PackageManagerComm  - X-Ref

initialize($login = true)   X-Ref
Initialize the soap client and store in the $GLOBALS object for use

param: login    designates whether we want to try to login after we initialize or not

errorCheck()   X-Ref
Check for errors in the response or error_str


setCredentials($username, $password, $download_key)   X-Ref
Set the credentials for use during login

param: username    Mambo username
param: password     Mambo password
param: download_key User's download key

clearSession()   X-Ref
Clears out the session so we can reauthenticate.


login($terms_checked = true)   X-Ref
Login to the depot

return: true if successful, false otherwise

logout()   X-Ref
Logout from the depot


getPromotion()   X-Ref
Get all promotions from the depot


getCategoryPackages($category_id, $filter = array()   X-Ref
A generic function which given a category_id some filter will
return an object which contains categories and packages

param: category_id  the category_id to fetch
param: filter       a filter which will limit theh number of results returned
return: categories_and_packages

getCategories($category_id, $filter = array()   X-Ref
Return a list of child categories to the parent specified in category_id

param: category_id  the parent category_id
param: filter       a filter which will limit theh number of results returned
return: categories_and_packages

getPackages($category_id, $filter = array()   X-Ref
Return a list of packages which belong to the parent category_id

param: category_id  the category_id to fetch
param: filter       a filter which will limit theh number of results returned
return: packages

getReleases($category_id, $package_id, $filter = array()   X-Ref
Return a list of releases belong to a package

param: category_id  the category_id to fetch
param: package_id  the package id which the release belongs to
return: packages

download($category_id, $package_id, $release_id)   X-Ref
Download a given release

param: category_id  the category_id to fetch
param: package_id  the package id which the release belongs to
param: release_id  the release we want to download
return: download

addDownload($category_id, $package_id, $release_id)   X-Ref
Add a requested download to the queue

param: category_id  the category_id to fetch
param: package_id  the package id which the release belongs to
param: release_id  the release we want to download
return: the filename to download

performDownload($filename, $save_dir)   X-Ref
Call the PackageManagerDownloader function which uses curl in order to download the specified file

param: filename    the file to download
return: path to downloaded file

getDocumentation($package_id, $release_id)   X-Ref
Retrieve documentation for the given release or package

param: package_id    the specified package to retrieve documentation
param: release_id    the specified release to retrieve documentation
return: documents

getTermsAndConditions()   X-Ref
Pas de description

downloadedDocumentation($document_id)   X-Ref
Log that the user has clicked on a document

param: document_id    the document the user has clicked on

checkForUpdates($objects_to_check)   X-Ref
Send the list of installed objects, could be patches, or modules, .. to the depot and allow the depot to send back
a list of corresponding updates

param: objects_to_check    an array of name_value_lists which contain the appropriate values
return: array of name_value_lists of corresponding updates    

isAlive()   X-Ref
Ping the server to determine if we have established proper communication

return: true if we can communicate with the server and false otherwise



Généré le : Tue Sep 11 10:48:47 2007 par Balluche grâce à PHPXref 0.7