kernel
[ class tree: kernel ] [ index: kernel ] [ all elements ]

Class: BitSystem

Source Location: /kernel/BitSystem.php

Class Overview

BitBase
   |
   --BitSingleton
      |
      --BitSystem

kernel::BitSystem


Author(s):

Variables

Methods


Child classes:

Inherited Constants

Inherited Variables

Inherited Methods

Class: BitSingleton

BitSingleton::__construct()
BitSingleton::loadSingleton()

Class: BitBase

BitBase::BitBase()
During initialisation, we assign a name which is used by the class.
BitBase::__construct()
BitBase::clearFromCache()
BitBase::expunge()
Delete content object and all related records
BitBase::load()
BitBase::__destruct()

Class Details

[line 49]
kernel::BitSystem

Purpose:

This is the main system class that does the work of seeing bitweaver has an operable environment and has methods for modifying that environment.

Currently gBitSystem derives from this class for backward compatibility sake. Ultimate goal is to put system code from BitBase here, and base code from gBitSystem (code that ALL features need) into BitBase and code gBitSystem that is Package specific should be moved into that package




Tags:

author:  spider <spider@steelsun.com>


[ Top ]


Class Variables

static $singleton =  null

[line 98]



Tags:

access:  protected

Type:   mixed


[ Top ]

$mActivePackage =

[line 66]


Type:   mixed


[ Top ]

$mAppMenu = array()

[line 63]


Type:   mixed


[ Top ]

$mConfig =

[line 81]


Type:   mixed


[ Top ]

$mContentClasses = array()

[line 90]


Type:   mixed


[ Top ]

$mDebugHtml =  ""

[line 93]


Type:   mixed


[ Top ]

$mHttpStatus =  HttpStatusCodes::HTTP_OK

[line 96]


Type:   mixed


[ Top ]

$mInstallModules = array()

[line 69]


Type:   mixed


[ Top ]

$mNotifyEvents = array()

[line 78]


Type:   mixed


[ Top ]

$mOnload = array()

[line 72]


Type:   mixed


[ Top ]

$mOnunload = array()

[line 75]


Type:   mixed


[ Top ]

$mPackageFileName =

[line 87]


Type:   mixed


[ Top ]

$mPackages = array()

[line 54]


Type:   mixed


[ Top ]

$mPackagesDirNameXref = array()

[line 57]


Type:   mixed


[ Top ]

$mRegisterCalled =

[line 84]


Type:   mixed


[ Top ]

$mStyle = array()

[line 60]


Type:   mixed


[ Top ]



Class Methods


static method genPass [line 1301]

static void genPass( )



[ Top ]

static method getSingleInstance [line 99]

static void getSingleInstance( )



Tags:

access:  protected


[ Top ]

static method loadFromCache [line 143]

static void loadFromCache( $pCacheKey)



Tags:

access:  public


Parameters:

   $pCacheKey  

[ Top ]

static method prependIncludePath [line 1481]

static void prependIncludePath( $pPath)

* Prepend $pPath to the include path

\static




Tags:

access:  public


Parameters:

   $pPath  

[ Top ]

constructor __construct [line 110]

BitSystem __construct( )

base constructor, auto assigns member db variable



Tags:

access:  public


Overrides BitSingleton::__construct() (parent method not documented)

[ Top ]

method appendIncludePath [line 1505]

void appendIncludePath( $pPath)

* Append $pPath to the include path

\static




Parameters:

   $pPath  

[ Top ]

method calculateRequirements [line 2099]

boolean calculateRequirements( [boolean $pInstallVersion = FALSE])

calculateRequirements will calculate all requirements and return a hash of the results



Tags:

return:  TRUE on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

boolean   $pInstallVersion   Use the actual installed version instead of the version that will be in bitweaver after the upgrade

[ Top ]

method checkBitVersion [line 2491]

returns checkBitVersion( )

checkBitVersion Check for new version of bitweaver



Tags:

return:  an array with information on bitweaver version
access:  public


[ Top ]

method checkEnvironment [line 1548]

void checkEnvironment( )



[ Top ]

method confirmDialog [line 740]

none confirmDialog( $pFormHash $pFormHash, $pMsg $pMsg)

This code was duplicated _EVERYWHERE_ so here is an easy template to cut that down.



Tags:

access:  public


Parameters:

$pFormHash   $pFormHash   documentation needed
$pMsg   $pMsg   documentation needed

[ Top ]

method diff2 [line 2556]

void diff2( $page1, $page2)



Parameters:

   $page1  
   $page2  

[ Top ]

method display [line 399]

void display( $mid $pMid, [$browserTitle $pBrowserTitle = NULL], [$format $pOptionsHash = array()])

Display the main page template



Tags:

access:  public


Parameters:

$mid   $pMid   the name of the template for the page content
$browserTitle   $pBrowserTitle   a string to be displayed in the top browser bar
$format   $pOptionsHash   the output format - xml, ajax, content, full - relays to setRenderFormat

[ Top ]

method drawRequirementsGraph [line 2165]

boolean drawRequirementsGraph( [boolean $pInstallVersion = FALSE], [string $pFormat = 'png'], [string $pCommand = 'dot'])

drawRequirementsGraph Will draw a requirement graph if PEAR::Image_GraphViz is installed



Tags:

return:  TRUE on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

boolean   $pInstallVersion   Use the actual installed version instead of the version that will be in bitweaver after the upgrade
string   $pFormat   dot output format
string   $pCommand   dot or neato

[ Top ]

method expungePackageConfig [line 307]

void expungePackageConfig( $pPackageName)

Delete all prefences for the given package



Tags:

access:  public


Parameters:

   $pPackageName  

[ Top ]

method fatalError [line 974]

none fatalError( $pMsg, [string $pTemplate = NULL], [string $pErrorTitle = NULL], [ $pHttpStatus = 200], string $)

If an unrecoverable error has occurred, this method should be invoked. script exist occurs



Tags:

return:  this function will DIE DIE DIE!!!
access:  public


Parameters:

string   $   pMsg error message to be displayed
string   $pTemplate   template file used to display error
string   $pErrorTitle   error dialog title. default gets site_error_title config, passing '' will result in no title
   $pMsg  
   $pHttpStatus  

[ Top ]

method fatalPermission [line 702]

none fatalPermission( $pPermission $pPermission, [$pMsg $pMsg = NULL])

Interupt code execution and show a permission denied message.

This does not show a big nasty denied message if user is simply not logged in. This *could* lead to a user seeing a denied message twice, however this is unlikely as logic permission checks should prevent access to non-permed page REQUEST in the first place




Tags:

access:  public


Parameters:

$pPermission   $pPermission   value of a given permission
$pMsg   $pMsg   optional additional information to present to user

[ Top ]

method getBitVersion [line 2477]

string getBitVersion( [boolean $pIncludeLevel = TRUE])

getBitVersion will fetch the version of bitweaver as set in kernel/config_defaults_inc.php



Tags:

return:  bitweaver version set in kernel/config_defaults_inc.php
access:  public


Parameters:

boolean   $pIncludeLevel   Return bitweaver version including BIT_LEVEL

[ Top ]

method getBrowserTitle [line 1266]

title getBrowserTitle( )

get the title of the browser



Tags:

return:  string
access:  public


[ Top ]

method getConfig [line 189]

void getConfig( $pName, [ $pDefault = NULL])

Add getConfig / setConfig for more uniform handling of config variables instead of spreading global vars.

easily get the value of any given preference stored in kernel_config




Tags:

access:  public


Parameters:

   $pName  
   $pDefault  

[ Top ]

method getConfigMatch [line 202]

void getConfigMatch( $pPattern, [ $pSelectValue = ""])

retreive a group of config variables



Tags:

access:  public


Parameters:

   $pPattern  
   $pSelectValue  

[ Top ]

method getDefaultPage [line 1120]

URL getDefaultPage( )

getDefaultPage



Tags:

return:  of site homepage
access:  public


[ Top ]

method getDefaultTempDir [line 1541]

void getDefaultTempDir( )



Tags:

access:  public


[ Top ]

method getErrorEmail [line 337]

void getErrorEmail( )

Smartly determines where error emails should go



Tags:

access:  public


[ Top ]

method getIncludeFiles [line 2578]

array getIncludeFiles( [array $pPhpFile = NULL], [array $pTplFile = NULL])

getIncludeFiles will get a set of available files with a given filename



Tags:

return:  of includable files
access:  public


Parameters:

array   $pPhpFile   name of php file
array   $pTplFile   name of tpl file

[ Top ]

method getIndexPage [line 1133]

URL getIndexPage( [ $pIndexType = NULL])

getIndexPage

Returns the page for the given type defaults to the site homepage




Tags:

return:  of page by index type
access:  public


Parameters:

   $pIndexType  

[ Top ]

method getLatestUpgradeVersion [line 1964]

string getLatestUpgradeVersion( array $pPackage)

getLatestUpgradeVersion will fetch the greatest upgrade number for a given package



Tags:

return:  greatest upgrade number for a given package
access:  public


Parameters:

array   $pPackage   package we want to fetch the latest version number for

[ Top ]

method getMimeExtension [line 1449]

void getMimeExtension( $pMimeType)



Parameters:

   $pMimeType  

[ Top ]

method getPackageStatus [line 562]

char getPackageStatus( $pPackageName $pPackageName)

find out a packages installation status



Tags:

return:  where 'i' is installed but not active 'y' is installed and active 'n' is not installed
access:  public


Parameters:

$pPackageName   $pPackageName   the name of the package to test where the package name is in the form used to index $mPackages

[ Top ]

method getPermissionDeniedMessage [line 720]

void getPermissionDeniedMessage( $pPermission)



Parameters:

   $pPermission  

[ Top ]

method getPermissionInfo [line 667]

none getPermissionInfo( [$pPermission $pPermission = NULL], [ $pPackageName = NULL])

It will get information about a permissions



Tags:

access:  public


Parameters:

$pPermission   $pPermission   value of a given permission
   $pPackageName  

[ Top ]

method getRequirements [line 2081]

array getRequirements( array $pPackage)

getRequirements



Tags:

return:  of package requirements
access:  public


Parameters:

array   $pPackage  

[ Top ]

method getUTCTime [line 2366]

void getUTCTime( )

Retrieve a current UTC timestamp

Simple map to BitDate object allowing tidy display elsewhere




[ Top ]

method getUTCTimestamp [line 2374]

void getUTCTimestamp( )

Retrieve a current UTC ISO timestamp

Simple map to BitDate object allowing tidy display elsewhere




[ Top ]

method getVersion [line 1946]

version getVersion( [array $pPackage = NULL], [ $pDefault = '0.0.0'], array $pVersion)

getVersion will fetch the version number of a given package



Tags:

return:  number on success
access:  public


Parameters:

array   $pPackage   Name of package - if not given, bitweaver_version will be stored
array   $pVersion   Version number
   $pDefault  

[ Top ]

method get_display_offset [line 2381]

void get_display_offset( [ $pUser = FALSE])

Retrieves the user's preferred offset for displaying dates.



Parameters:

   $pUser  

[ Top ]

method get_long_datetime [line 2466]

void get_long_datetime( $pTimestamp, [ $pUser = FALSE])



Parameters:

   $pTimestamp  
   $pUser  

[ Top ]

method get_long_datetime_format [line 2440]

void get_long_datetime_format( )

Retrieves the user's preferred long date/time format for displaying dates.



[ Top ]

method get_long_date_format [line 2388]

void get_long_date_format( )

Retrieves the user's preferred long date format for displaying dates.



[ Top ]

method get_long_time_format [line 2414]

void get_long_time_format( )

Retrieves the user's preferred long time format for displaying dates.



[ Top ]

method get_short_datetime_format [line 2453]

void get_short_datetime_format( )

Retrieves the user's preferred short date/time format for displaying dates.



[ Top ]

method get_short_date_format [line 2401]

void get_short_date_format( )

Retrieves the user's preferred short date format for displaying dates.



[ Top ]

method get_short_time_format [line 2427]

void get_short_time_format( )

Retrieves the user's preferred short time format for displaying dates.



[ Top ]

method hasValidSenderEmail [line 324]

void hasValidSenderEmail( [$mid $pSenderEmail = NULL])

Determines if this site has a legitimate sender address set.



Tags:

access:  public


Parameters:

$mid   $pSenderEmail   the name of the template for the page content

[ Top ]

method isFeatureActive [line 766]

none isFeatureActive( $pKey $pFeatureName)

check's if the specfied feature is active



Tags:

access:  public


Parameters:

$pKey   $pFeatureName   hash key

[ Top ]

method isLive [line 1729]

TRUE isLive( )

isLive returns status of the IS_LIVE constant from config/kernel/config_inc.php



Tags:

return:  if IS_LIVE is defined and set to a non empty value, else FALSE
access:  public


[ Top ]

method isPackageActive [line 597]

boolean isPackageActive( $pPackageName $pPackageName)

check's if a package is active.



Tags:

access:  public


Parameters:

$pPackageName   $pPackageName   the name of the package to test where the package name is in the form used to index $mPackages See comments in scanPackages for more information

[ Top ]

method isPackageActiveEarly [line 613]

boolean isPackageActiveEarly( $pPackageName $pPackageName)

check if a package is active; but only do this after making sure a package

has had it's bit_setup_inc loaded if possible. This func exists for use in other packages bit_setup_inc's to avoid dependency on load order and ugly code




Tags:

access:  public


Parameters:

$pPackageName   $pPackageName   the name of the package to test where the package name is in the form used to index $mPackages See comments in scanPackages for more information

[ Top ]

method isPackageInstalled [line 636]

boolean isPackageInstalled( $pPackageName $pPackageName)

check's if a package is Installed



Tags:

access:  public


Parameters:

$pPackageName   $pPackageName   the name of the package to test where the package name is in the form used to index $mPackages See comments in scanPackages for more information

[ Top ]

method loadConfig [line 161]

void loadConfig( [$pPackage $pPackage = NULL])

Load all preferences and store them in $this->mConfig



Parameters:

$pPackage   $pPackage   optionally get preferences only for selected package

[ Top ]

method loadMimeTypes [line 1343]

mime loadMimeTypes( string $pExtension)

given an extension, return the mime type



Tags:

return:  type of entry and populates $this->mMimeTypes with existing mime types
access:  public


Parameters:

string   $pExtension   is the extension of the file or the complete file name

[ Top ]

method loadPackage [line 1012]

none loadPackage( $pPkgDir, $pScanFile, [ $pAutoRegister = TRUE], [ $pOnce = TRUE], string $)

Loads a package



Tags:

access:  public


Parameters:

string   $   pOnce - TRUE = do include_once to load file FALSE = do include to load the file
   $pPkgDir  
   $pScanFile  
   $pAutoRegister  
   $pOnce  

[ Top ]

method lookupMimeType [line 1323]

mime lookupMimeType( string $pExtension)

given an extension, return the mime type



Tags:

return:  type of entry and populates $this->mMimeTypes with existing mime types
access:  public


Parameters:

string   $pExtension   is the extension of the file or the complete file name

[ Top ]

method outputHeader [line 386]

void outputHeader( )



Tags:

access:  public


[ Top ]

method registerAppMenu [line 918]

none registerAppMenu( $pKey $pMenuHash, [ $pMenuTitle = NULL], [ $pTitleUrl = NULL], [ $pMenuTemplate = NULL], [ $pAdminPanel = FALSE])

Register global system menu. Due to the startup nature of this method, it need to belong in BitSystem instead of BitThemes, where it would more naturally fit.



Tags:

access:  public


Parameters:

$pKey   $pMenuHash   hash key
   $pMenuTitle  
   $pTitleUrl  
   $pMenuTemplate  
   $pAdminPanel  

[ Top ]

method registerConfig [line 1798]

TRUE registerConfig( array $pPackagedir, array $pPreferences)

registerConfig



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackagedir  
array   $pPreferences  

[ Top ]

method registerContentObjects [line 1837]

void registerContentObjects( string $pPackageName, hash $pClassesHash)

registerContentObjects



Tags:

access:  public


Parameters:

string   $pPackageName   the package name
hash   $pClassesHash   [$className => $pathToClassFile]

[ Top ]

method registerModules [line 1826]

TRUE registerModules( array $pModuleHash)

registerModules



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pModuleHash  

[ Top ]

method registerNotifyEvent [line 960]

TRUE registerNotifyEvent( array $pEventHash)

registerNotifyEvent



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pEventHash  

[ Top ]

method registerPackage [line 801]

none registerPackage( $pKey $pRegisterHash)

Define name, location and url DEFINE's



Tags:

access:  public


Parameters:

$pKey   $pRegisterHash   hash key

[ Top ]

method registerPackageInfo [line 1849]

TRUE registerPackageInfo( array $pPackage, array $pInfoHash)

registerPackageInfo



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackage  
array   $pInfoHash  

[ Top ]

method registerPackageVersion [line 1991]

void registerPackageVersion( array $pPackage, array $pVersion)

registerPackageVersion Holds the package version



Tags:

access:  public


Parameters:

array   $pPackage  
array   $pVersion  

[ Top ]

method registerPreferences [line 1813]

TRUE registerPreferences( array $pPackagedir, array $pPreferences)

registerPreferences



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackagedir  
array   $pPreferences  

[ Top ]

method registerRequirements [line 2017]

void registerRequirements( $pPackage, array $pReqHash, array $pParams)

registerRequirements



Tags:

access:  public


Parameters:

array   $pParams  
array   $pReqHash  
   $pPackage  

[ Top ]

method registerSchemaConstraints [line 1766]

void registerSchemaConstraints( array $pPackage, array $pTableName, array $pConstraints)

registerSchemaConstraints



Tags:

access:  public


Parameters:

array   $pPackage  
array   $pTableName  
array   $pConstraints  

[ Top ]

method registerSchemaDefault [line 1901]

TRUE registerSchemaDefault( array $pPackage, array $pMixedDefaultSql)

registerSchemaDefault



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackage  
array   $pMixedDefaultSql  

[ Top ]

method registerSchemaIndexes [line 1888]

TRUE registerSchemaIndexes( array $pPackage, array $pIndexHash)

registerSchemaIndexes



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackage  
array   $pIndexHash  

[ Top ]

method registerSchemaSequences [line 1875]

TRUE registerSchemaSequences( array $pPackage, array $pSeqHash)

registerSchemaSequences



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackage  
array   $pSeqHash  

[ Top ]

method registerSchemaTable [line 1747]

void registerSchemaTable( array $pPackage, array $pTableName, array $pDataDict, [array $pRequired = FALSE], [array $pTableOptions = NULL])

registerSchemaTable



Tags:

access:  public


Parameters:

array   $pPackage  
array   $pTableName  
array   $pDataDict  
array   $pRequired  
array   $pTableOptions  

[ Top ]

method registerUserPermissions [line 1781]

TRUE registerUserPermissions( array $pPackagedir, array $pUserpermissions)

registerUserPermissions



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pPackagedir  
array   $pUserpermissions  

[ Top ]

method scanPackages [line 1081]

none scanPackages( [ $pScanFile = 'bit_setup_inc.php'], [ $pOnce = TRUE], [ $pSelect = ''], [ $pAutoRegister = TRUE], string $)

scan all available packages. This is an *expensive* function. DO NOT call this functionally regularly , or arbitrarily. Failure to comply is punishable by death by jello suffication!



Tags:

return:  

Packages have three different names: The directory name where they reside on disk The Name they register themselves as when they call registerPackage The Key for the array $this->mPackages

Example: A package in directory 'stars' that registers itself with a name of 'Star Ratings' would have these three names:

Directory Name: 'stars' Registered Name: Star Ratings' $this->mPackages key: 'star_ratings'

Of course, its possible for all three names to be the same if the registered name is all lower case without spaces and is the same as the diretory name.

Functions that expect a package name as a parameter should make clear which form of the name they expect.

access:  public


Parameters:

string   $   fileSystemScan - TRUE = scan file system for packages to load, False = don't
   $pScanFile  
   $pOnce  
   $pSelect  
   $pAutoRegister  

[ Top ]

method sendEmail [line 356]

void sendEmail( $mid $pMailHash)

centralized function for send emails



Tags:

access:  public


Parameters:

$mid   $pMailHash   the name of the template for the page content

[ Top ]

method setBrowserTitle [line 1279]

none setBrowserTitle( $pTitle, string $)

set the title of the browser



Tags:

access:  public


Parameters:

string   $   pTitle title to be used
   $pTitle  

[ Top ]

method setCanonicalLink [line 1294]

none setCanonicalLink( $pRelativeUrl, string $)

set the canonical page title



Tags:

access:  public


Parameters:

string   $   pTitle title to be used
   $pRelativeUrl  

[ Top ]

method setConfig [line 249]

void setConfig( string $pName, string $pValue)

Set a hash value in the mConfig hash. This does *NOT* store the value in the database. It does no checking for existing or duplicate values. the main point of this function is to limit direct accessing of the mConfig hash. I will probably make mConfig private one day.



Parameters:

string   $pName   Hash key for the mConfig value
string   $pValue   Value for the mConfig hash key

[ Top ]

method setHttpStatus [line 381]

void setHttpStatus( $pHttpStatus $pHttpStatus)

Set the http status, most notably for 404 not found for deleted content



Tags:

access:  public


Parameters:

$pHttpStatus   $pHttpStatus   numerical HTTP status, most typically 404 (not found) or 403 (forbidden)

[ Top ]

method setOnloadScript [line 1245]

none setOnloadScript( $pJavscript, string $pJavascript)

add javascript to the <body onload> attribute



Tags:

access:  public


Parameters:

string   $pJavascript   javascript to be added
   $pJavscript  

[ Top ]

method setOnunloadScript [line 1256]

none setOnunloadScript( $pJavscript, string $pJavascript)

add javascript to the <body onunload> attribute



Tags:

access:  public


Parameters:

string   $pJavascript   javascript to be added
   $pJavscript  

[ Top ]

method storeConfig [line 265]

void storeConfig( $pName, $pValue, [ $pPackage = NULL])

bitweaver needs lots of settings just to operate.

loadConfig assigns itself the default preferences, then loads just the differences from the database. In storeConfig (and only when storeConfig is called) we make a second copy of defaults to see if preferences you are changing is different from the default. if it is the same, don't store it! So instead updating the whole prefs table, only updat "delta" of the changes delta from defaults.




Tags:

access:  public


Parameters:

   $pName  
   $pValue  
   $pPackage  

[ Top ]

method storeConfigMatch [line 227]

TRUE storeConfigMatch( string $pPattern, [string $pSelectValue = ""], [string $pNewValue = NULL], [string $pPackage = NULL])

storeConfigMatch set a group of config variables



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

string   $pPattern   Perl regular expression
string   $pSelectValue   only manipulate settings with this value set
string   $pNewValue   New value that should be set for the matching settings (NULL will remove the entries from the DB)
string   $pPackage   Package for which the settings are

[ Top ]

method storeVersion [line 1923]

TRUE storeVersion( [array $pPackage = NULL], array $pVersion)

storeVersion will store the version number of a given package



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

array   $pPackage   Name of package - if not given, bitweaver_version will be stored
array   $pVersion   Version number

[ Top ]

method validateVersion [line 2005]

TRUE validateVersion( array $pVersion)

validateVersion



Tags:

return:  on success, FALSE on failure
access:  public


Parameters:

array   $pVersion  

[ Top ]

method verifyFeature [line 785]

none verifyFeature( $pFeatureName $pFeatureName, $pKey 1)

It will verify that the given feature is active or it will display the error template and die()



Tags:

access:  public


Parameters:

$pKey   1   hash key
$pFeatureName   $pFeatureName   the name of the package to test

[ Top ]

method verifyFileExtension [line 1377]

corrected verifyFileExtension( string $pFile, [string $pFileName = NULL])

given a file and optionally desired name, return the correctly extensioned file and mime type



Tags:

return:  file name and mime type
access:  public


Parameters:

string   $pFile   is the actual file to inspect for magic numbers to determine type
string   $pFileName   is the desired name the file. This is optional in the even the pFile is non-extensioned, as is the case with file uploads

[ Top ]

method verifyInstalledPackages [line 2274]

none verifyInstalledPackages( [ $pSelect = 'installed'], string $)

verifyInstalledPackages scan all available packages



Tags:

access:  public


Parameters:

string   $   pScanFile file to be looked for
   $pSelect  

[ Top ]

method verifyMimeType [line 1422]

mime verifyMimeType( $pFile, string $pExtension)

given a file, return the mime type



Tags:

return:  type of entry and populates $this->mMimeTypes with existing mime types
access:  public


Parameters:

string   $pExtension   is the extension of the file or the complete file name
   $pFile  

[ Top ]

method verifyPackage [line 652]

boolean verifyPackage( $pPackageName $pPackageName)

It will verify that the given package is active or it will display the error template and die()



Tags:

access:  public


Parameters:

$pPackageName   $pPackageName   the name of the package to test where the package name is in the form used to index $mPackages See comments in scanPackages for more information

[ Top ]

method verifyPermission [line 686]

void verifyPermission( $pPermission, [ $pMsg = NULL])

DEPRECATED - this function has been moved into BitPermUser, use that



Parameters:

   $pPermission  
   $pMsg  

[ Top ]

method verifyRequirements [line 2046]

TRUE verifyRequirements( &$pReqHash, array $pReqHash)

verifyRequirements



Tags:

return:  on success, FALSE on failure - mErrors will contain reason for failure
access:  public


Parameters:

array   $pReqHash  
   &$pReqHash  

[ Top ]


Documentation generated on Wed, 29 Jul 2015 13:56:02 +0000 by phpDocumentor 1.5.0-lsces