ModuleInstall/PackageManager/PackageManager.php

Show:

inherited

Constants
Functions
Classes
- \PackageManager

Table of Contents

Constants

 
                CREDENTIAL_CATEGORY
                = "ml"

 
                CREDENTIAL_USERNAME
                = "username"

 
                CREDENTIAL_PASSWORD
                = "password"

\PackageManager
jump to top

Package:

Properties


                 $soap_client= ''

Details

Type: n/a

Methods

PackageManager(
          
          )
        
        :
          void

Constructor: In this method we will initialize the nusoap client to point to the hearbeat server

authenticate(
          \username $username, \password $password, \systemname $systemname
              =
              '',  $terms_checked
              =
              true
          )
        
        :
          true

Given the Mambo username, password, and download key attempt to authenticate, if successful then store these credentials

Parameters

Name	Type	Description
$username	\username	Mambo username
$password	\password	Mambo password
$systemname	\systemname	the user's download key
$terms_checked

Returns

Type	Description
true	if successful, false otherwise

buildInstalledReleases(
           $types
              =
              array('module')
          )
        
        :
          void

Parameters

Name	Type	Description
$types

buildPackageXML(
           $package,  $releases
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$package
$releases

checkForUpdates(
          
          )
        
        :
          void

Grab the list of installed modules and send that list to the depot.

The depot will then send back a list of modules that need to be updated

download(
          \category_id $category_id, \package_id $package_id, \release_id $release_id
          )
        
        :
          \filename

Retrieve the package as specified by the $id from the heartbeat server

Parameters

Name	Type	Description
$category_id	\category_id	the category_id to which the release belongs
$package_id	\package_id	the package_id to which the release belongs
$release_id	\release_id	the release_id to download

Returns

Type	Description
\filename	- the path to which the zip file was saved

extractFile(
           $zip_file,  $file_in_zip,  $base_tmp_upgrade_dir
          )
        
        :
          void

Parameters

Name	Type	Description
$zip_file
$file_in_zip
$base_tmp_upgrade_dir

extractManifest(
           $zip_file,  $base_tmp_upgrade_dir
          )
        
        :
          void

Parameters

Name	Type	Description
$zip_file
$base_tmp_upgrade_dir

fromNameValueList(
           $nvl
          )
        
        :
          void

Parameters

Name	Type	Description
$nvl

getCategories(
          \category_id $category_id, \filter $filter
              =
              array()
          )
        
        :
          array

Get a list of categories from the SugarDepot

Parameters

Name	Type	Description
$category_id	\category_id	the category id of parent to obtain
$filter	\filter	an array of filters to pass to limit the query

Returns

Type	Description
array	an array of categories for display on the client

getCategoryPackages(
           $category_id
              =
              '',  $filter
              =
              array()
          )
        
        :
          \category_packages

Obtain the list of category_packages from SugarDepot

Parameters

Name	Type	Description
$category_id
$filter

Returns

Type	Description
\category_packages

getCredentials(
          
          )
        
        :
          void

getDocumentation(
          \package_id $package_id, \release_id $release_id
          )
        
        :
          \documents

Retrieve documentation for the given release or package

Parameters

Name	Type	Description
$package_id	\package_id	the specified package to retrieve documentation
$release_id	\release_id	the specified release to retrieve documentation

Returns

Type	Description
\documents

getImageForType(
           $type
          )
        
        :
          void

Parameters

Name	Type	Description
$type

getInstallType(
           $type_string
          )
        
        :
          void

Parameters

Name	Type	Description
$type_string

getInstalled(
          \type $types
              =
              array('module')
          )
        
        :
          \an

Run the query to obtain the list of installed types as specified by the type param

Parameters

Name	Type	Description
$types	\type	an array of types you would like to search for type options include (theme, langpack, module, patch)

Returns

Type	Description
\an	array of installed upgrade_history objects

getLicenseFromFile(
           $file
          )
        
        :
          void

Parameters

Name	Type	Description
$file

getModuleLoaderCategoryPackages(
           $category_id
              =
              ''
          )
        
        :
          void

Obtain a list of category/packages/releases for use within the module loader

Parameters

Name	Type	Description
$category_id

getPackages(
           $category_id,  $filter
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$category_id
$filter

getPackagesInStaging(
           $view
              =
              'module'
          )
        
        :
          void

Parameters

Name	Type	Description
$view

getPromotion(
          
          )
        
        :
          string

Obtain a promotion from SugarDepot

Returns

Type	Description
string	the string from the promotion

getReleases(
           $category_id,  $package_id,  $filter
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$category_id
$package_id
$filter

getTermsAndConditions(
          
          )
        
        :
          void

getUITextForType(
           $type
          )
        
        :
          void

Parameters

Name	Type	Description
$type

getinstalledPackages(
           $types
              =
              array('module', 'langpack')
          )
        
        :
          void

Parameters

Name	Type	Description
$types

initializeComm(
          
          )
        
        :
          void

performInstall(
           $file,  $silent
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$file
$silent

performSetup(
           $tempFile,  $view
              =
              'module',  $display_messages
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$tempFile
$view
$display_messages

performUninstall(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

setCredentials(
           $username,  $password,  $systemname
          )
        
        :
          void

Parameters

Name	Type	Description
$username
$password
$systemname

toNameValueList(
           $array
          )
        
        :
          void

Parameters

Name	Type	Description
$array

toNameValueLists(
           $arrays
          )
        
        :
          void

Parameters

Name	Type	Description
$arrays

unlinkTempFiles(
          
          )
        
        :
          void

validate_manifest(
           $manifest
          )
        
        :
          void

Parameters

Name	Type	Description
$manifest

ModuleInstall/PackageManager/PackageManager.php

Constants

\PackageManagerjump to top

Properties

Methods

\PackageManager
jump to top