PackagerBase Class Reference

Inheritance diagram for PackagerBase:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 fetchRemoteXmlFiles ()
 getInstalledVersion ($pPackage)
 getLatestVersion ($pPackage)
 getPackageFilename ($pParamHash=NULL)
 getPackageFilepath ($pParamHash=NULL)
 getPackageUrl ($pParamHash=NULL)
 getStoragePath ($pSubDir=NULL)
 getStorageUrl ($pSubDir=NULL)
 getVersionFromFile ($pFile)
 getXmlFilepath ($pTable)
 getXmlUrl ($pTable, $pRemote=FALSE)
 isDownloaded ($pParamHash=NULL)
 isOwner ()
 isServer ()
 PackagerBase ()
 packagerDbToXml ()
 packagerXmlToDb ()
 postStore ()
 tableToXml ($pTable, $pQuery=NULL, $pBindvars=array())
 verifyServer ()
 versionCompare ($pOne, $pTwo)
 xmlToDatabase ($pTable)

Public Attributes

 $mConfig = array()
 $mHost = 'www.bitweaver.org'
 $mTables = array()

Detailed Description

Packager

BitBase

Definition at line 9 of file PackagerBase.php.

Member Function Documentation

PackagerBase::fetchRemoteXmlFiles (  ) 

This will fetch all XML files from the host

public

Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 195 of file PackagerBase.php.

References $tables, $xml, bit_http_request(), date, getXmlFilepath(), getXmlUrl(), isServer(), tra(), and up.

Here is the call graph for this function:

PackagerBase::getInstalledVersion ( $  pPackage  ) 

get the version as stored in the database

Parameters:
array $pPackage public
Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 343 of file PackagerBase.php.

References $gBitSystem, $ret, $version, FALSE, and mPackages.

Referenced by Packager::getList(), and PackagerInstall::getSchemaUpgrades().

PackagerBase::getLatestVersion ( $  pPackage  ) 

get the most recent version of a given package

Parameters:
array $pPackage public
Returns:
latest version number of given package

Definition at line 232 of file PackagerBase.php.

References $query, $ret, PackagerVersions::getDisplayUrl(), getPackageUrl(), and mDb.

Referenced by Packager::getList(), and PackagerVersions::storeUpload().

Here is the call graph for this function:

PackagerBase::getPackageFilename ( $  pParamHash = NULL  ) 

Definition at line 281 of file PackagerBase.php.

References $pParamHash, FALSE, and mInfo.

Referenced by PackagerVersions::load().

PackagerBase::getPackageFilepath ( $  pParamHash = NULL  ) 

Definition at line 277 of file PackagerBase.php.

References $pParamHash, and getStoragePath().

Referenced by PackagerVersions::expunge(), PackagerInstall::fetchRemotePackage(), isDownloaded(), PackagerVersions::load(), PackagerInstall::prepareVersionForInstall(), and PackagerVersions::storeUpload().

Here is the call graph for this function:

PackagerBase::getPackageUrl ( $  pParamHash = NULL  ) 

get the url to download the package from the remote server

Parameters:
array $pParamHash public
Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 299 of file PackagerBase.php.

References $gBitSystem, $pParamHash, and mInfo.

Referenced by getLatestVersion(), PackagerVersions::getList(), and PackagerVersions::load().

PackagerBase::getStoragePath ( $  pSubDir = NULL  ) 

Definition at line 251 of file PackagerBase.php.

References LibertyAttachable::getStoragePath().

Referenced by getPackageFilepath(), getXmlFilepath(), PackagerInstall::prepareVersionForInstall(), and PackagerVersions::storeUpload().

Here is the call graph for this function:

PackagerBase::getStorageUrl ( $  pSubDir = NULL  ) 

Definition at line 247 of file PackagerBase.php.

References LibertyAttachable::getStorageUrl().

Referenced by getXmlUrl().

Here is the call graph for this function:

PackagerBase::getVersionFromFile ( $  pFile  ) 

use a regular expression to extract the package version from a given file

Parameters:
array $pFile public
Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 321 of file PackagerBase.php.

References $content, and $ret.

Referenced by PackagerInstall::getSchemaFiles(), PackagerInstall::getSchemaUpgrades(), PackagerInstall::prepareVersionForInstall(), and PackagerVersions::storeUpload().

PackagerBase::getXmlFilepath ( $  pTable  ) 

getXmlFilepath

Parameters:
array $pTable public
Returns:
path to xml file

Definition at line 129 of file PackagerBase.php.

References getStoragePath().

Referenced by fetchRemoteXmlFiles(), tableToXml(), and xmlToDatabase().

Here is the call graph for this function:

PackagerBase::getXmlUrl ( $  pTable,
$  pRemote = FALSE 
)

get the url to the local xml file

Parameters:
array $pTable public
Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 140 of file PackagerBase.php.

References $gBitSystem, and getStorageUrl().

Referenced by fetchRemoteXmlFiles().

Here is the call graph for this function:

PackagerBase::isDownloaded ( $  pParamHash = NULL  ) 

this will confirm that the file is present and that the file matches the md5 hash created when the file was compressed

Parameters:
array $pParamHash public
Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 262 of file PackagerBase.php.

References $pParamHash, $ret, FALSE, getPackageFilepath(), and mInfo.

Referenced by PackagerInstall::fetchRemotePackage(), and PackagerInstall::prepareVersionForInstall().

Here is the call graph for this function:

PackagerBase::isOwner (  ) 

check to see if the user who is viewing / editing a given item is the owner of the item. editing stuff is only possible on the server, so this will also perform an isServer() check

public

Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 396 of file PackagerBase.php.

References $gBitUser, isServer(), mInfo, and mUserId.

Here is the call graph for this function:

PackagerBase::isServer (  ) 

isServer

public

Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 409 of file PackagerBase.php.

References $_SERVER.

Referenced by PackagerVersions::addHit(), fetchRemoteXmlFiles(), isOwner(), postStore(), and verifyServer().

PackagerBase::PackagerBase (  ) 

Initiate class

Returns:
void

Definition at line 24 of file PackagerBase.php.

References $gBitSystem, and BitBase::BitBase().

Referenced by Packager::Packager(), and PackagerVersions::PackagerVersions().

Here is the call graph for this function:

PackagerBase::packagerDbToXml (  ) 

packagerDbToXml

public

Returns:
void

Definition at line 159 of file PackagerBase.php.

References tableToXml().

Referenced by postStore().

Here is the call graph for this function:

PackagerBase::packagerXmlToDb (  ) 

packagerXmlToDb

public

Returns:
void

Definition at line 172 of file PackagerBase.php.

References mDb, and xmlToDatabase().

Here is the call graph for this function:

PackagerBase::postStore (  ) 

postStore

public

Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 419 of file PackagerBase.php.

References isServer(), and packagerDbToXml().

Referenced by PackagerVersions::expunge(), Packager::expunge(), PackagerVersions::store(), and Packager::store().

Here is the call graph for this function:

PackagerBase::tableToXml ( $  pTable,
$  pQuery = NULL,
$  pBindvars = array() 
)

tableToXml

Parameters:
array $pTable public
Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 51 of file PackagerBase.php.

References $i, $rs, $tag, getXmlFilepath(), and mDb.

Referenced by packagerDbToXml().

Here is the call graph for this function:

PackagerBase::verifyServer (  ) 

Definition at line 425 of file PackagerBase.php.

References $gBitSystem, isServer(), and tra().

Here is the call graph for this function:

PackagerBase::versionCompare ( $  pOne,
$  pTwo 
)

versionCompare

Parameters:
mixed $pOne array or string containing version and status information
mixed $pTwo same as $pOne public
Returns:
comparative result of version_compare()

Definition at line 366 of file PackagerBase.php.

Referenced by array_version_compare(), Packager::getList(), PackagerInstall::getSchemaFiles(), PackagerInstall::getSchemaUpgrades(), PackagerInstall::prepareVersionForInstall(), schemafile_version_compare(), and PackagerVersions::storeUpload().

PackagerBase::xmlToDatabase ( $  pTable  ) 

xmlToDatabase

Parameters:
array $pXmlFile
array $pTable public
Returns:
TRUE on success, FALSE on failure - mErrors will contain reason for failure

Definition at line 91 of file PackagerBase.php.

References $i, $result, $row, $storeHash, getXmlFilepath(), and mDb.

Referenced by packagerXmlToDb().

Here is the call graph for this function:

Member Data Documentation

PackagerBase::$mConfig = array()

Definition at line 17 of file PackagerBase.php.

PackagerBase::$mHost = 'www.bitweaver.org'

Definition at line 14 of file PackagerBase.php.

PackagerBase::$mTables = array()

Definition at line 11 of file PackagerBase.php.

The documentation for this class was generated from the following file:
Generated on Wed Aug 22 19:34:49 2007 for bitweaver by  doxygen 1.5.2