In the example we called the URL library found in the folder: include/library/phpfox/url/url.class.php then created an object for it so we could directly call the method "makeUrl".

return: of the library class is returned.
access: public

object Object &getLib (string $sClass, [array $aParams = array()])

string $sClass: Library class name.
array $aParams: ARRAY of params you can pass to the library.

static getLibClass (line 258)

Fine and load a library class and make sure it exists.

return: TRUE if library has loaded, FALSE if not.
access: public

bool getLibClass (string $sClass)

string $sClass: Library class name.

static getMessage (line 1245)

Get the public message we setup earlier

return: Return the public message, or return nothing if no public message is set
see: Phpfox_Session::get()
access: public

string|void getMessage ()

static getObject (line 205)

Gets and creates an object for a class.

return: created will be returned.
access: public

object Object &getObject (string $sClass, [array $aParams = array()])

string $sClass: Class name.
array $aParams: Params to pass to the class.

static getParam (line 247)

see: Phpfox_Setting::getParam()
access: public

mixed getParam (string $sVar)

string $sVar

static getPhrase (line 1210)

see: Phpfox_Local::getPhrase()
access: public

string getPhrase (string $sParam, [array $aParams = array()], [bool $bNoDebug = false], [string $sDefault = null], [string $sLang = ''])

string $sParam
array $aParams
bool $bNoDebug
string $sDefault
string $sLang

static getPhraseT (line 1221)

see: Phpfox_Locale::translate()
access: public

string getPhraseT (string $sParam, string $sPrefix)

string $sParam
string $sPrefix

static getService (line 425)

see: Phpfox_Module::getService()
access: public

object getService (string $sClass, [array $aParams = array()])

string $sClass
array $aParams

static getT (line 436)

Builds a database table prefix.

return: Returns the table name with the clients prefix.
access: public

string getT (string $sTable)

string $sTable: Database table name.

static getTime (line 569)

Gets a time stamp, Works similar to PHP date() function.

We also take into account locale and time zone settings.

return: Time stamp value based on locale.
see: date()
access: public

string getTime ([string $sStamp = null], [int $iTime = PHPFOX_TIME])

string $sStamp: Time stamp format.
int $iTime: UNIX epoch time stamp.

static getTimeZone (line 555)

see: Phpfox_Date::getTimeZone()
access: public

string getTimeZone ([bool $bDst = true])

bool $bDst

static getUserBy (line 454)

see: User_Service_Auth::getUserBy()
access: public

string getUserBy ([ $sVar = null])

$sVar

static getUserField (line 509)

Get all the user fields when joining with the user database table.

return: Returns SQL SELECT for user fields.
access: public

string getUserField ([string $sAlias = 'u'], [string $sPrefix = ''])

string $sAlias: Table alias. User table alias by default is "u".
string $sPrefix: Prefix for each of the fields.

static getUserGroupParam (line 755)

see: User_Service_Group_Setting_Setting::getGroupParam()
access: public

mixed getUserGroupParam (int $iGroupId, string $sName)

int $iGroupId
string $sName

static getUserId (line 445)

see: User_Service_Auth::getUserId()
access: public

int getUserId ()

static getUserParam (line 769)

Get a user group setting.

see: User_Service_Group_Setting_Setting::getParam()
access: public

unknown getUserParam (string $sName, [bool $bRedirect = false], [mixed $sJsCall = null])

string $sName: User group param name.
bool $bRedirect: TRUE will redirect the user to a subscribtion page if they do not have access to the param.
mixed $sJsCall: NULL will do nothing, however a STRING JavaScript code will run the code instead of a redirection.

static getVersion (line 104)

Get the current phpFox version.

access: public

string getVersion ()

static hasCallback (line 390)

see: Phpfox_Module::hasCallback()
access: public

bool hasCallback (string $sModule, string $sMethod)

string $sModule
string $sMethod

static isAdmin (line 713)

Used to see if a user is an Admin. By passing the first argument as TRUE we can also do an auto redirect to guide the user to login first before using a feature in the AdminCP.

return: If the 1st argument is FALSE, it will return a BOOL TRUE if the user is logged in, otherwise FALSE.
access: public

bool isAdmin ([bool $bRedirect = false])

bool $bRedirect: User will be redirected to the AdminCP login page if they are not logged int.

static isAdminPanel (line 871)

Check to see if we are in the AdminCP or not.

return: if we are, FALSE if we are not.
access: public

TRUE isAdminPanel ()

static isMobile (line 463)

see: Phpfox_Request::isMobile()
access: public

bool isMobile ()

static isModule (line 334)

see: Phpfox_Module::isModule()
access: public

bool isModule (string $sModule)

string $sModule

static isPackage (line 171)

Check if a feature can be used based on the package the client has installed.

Example (STRING):

if (Phpfox::isPackage('1') { }

Example (ARRAY):

if (Phpfox::isPackage(array('1', '2')) { }

access: public

unknown isPackage (mixed $mPackage)

mixed $mPackage: STRING can be used to pass the package ID, or an ARRAY to pass multipl packages.

static isPublicView (line 881)

Check to see if items are to be displayed in a public manner or within a persons profile.

return: TRUE will display items in public and FALSE will display on a users profile.
access: public

bool isPublicView ()

static isSpammer (line 482)

Checks to see if the user that is logged in has been marked as a spammer.

return: TRUE is a spammer, FALSE if not a spammer.
access: public

bool isSpammer ()

static isUser (line 683)

Used to see if a user is logged in or not. By passing the first argument as TRUE we can also do an auto redirect to guide the user to login first before using a feature.

return: If the 1st argument is FALSE, it will return a BOOL TRUE if the user is logged in, otherwise FALSE.
access: public

bool isUser ([bool $bRedirect = false])

bool $bRedirect: User will be redirected to the login page if they are not logged int.

static itemUrl (line 737)

Creates a URL for an item that is connected with a users profile.

return: Items URL now connected with a persons profile.
deprecated: 2.0.0beta1
access: public

string itemUrl (string $sUrl, array $mParams, string $sUserName)

string $sUrl: URL
array $mParams: URL params.
string $sUserName: Users vanity user name.

static link (line 193)

Provide "powered by" link.

return: Powered by phpFox string returned.
access: public

string link ([bool $bLink = true], [bool $bVersion = true])

bool $bLink: TRUE to include a link to phpFox.
bool $bVersion: TRUE to include the version being used.

static log (line 1308)

Log a message.

access: public

void log (string $sLog)

string $sLog: Message to the log.

static massCallback (line 372)

see: Phpfox_Module::massCallback()
access: public

mixed massCallback (string $sMethod)

string $sMethod

static run (line 890)

Starts the phpFox engine. Used to get and display the pages controller.

access: public

void run ()

static setCookie (line 1268)

Set a cookie with PHP setcookie()

see: setcookie()
access: public

void setCookie (string $sName, string $sValue, [int $iExpire = 0])

string $sName: The name of the cookie.
string $sValue: The value of the cookie.
int $iExpire: The time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch.

static startLog (line 1293)

Start a new log.

access: public

void startLog ([string $sLog = null])

string $sLog: Message to the log.

Class Constants

BROWSER_AGENT = 'phpFox' (line 43)

Browser agent used with API curl requests.

CODE_NAME = 'Arctic' (line 37)

Product Code Name

see: http://en.wikipedia.org/wiki/Arctic_Fox

PHPFOX_API = 'http://api.phpfox.com/deepspace/' (line 55)

phpFox API server.

PHPFOX_PACKAGE = '[PHPFOX_PACKAGE_NAME]' (line 61)

phpFox package ID.

PRODUCT_BUILD = '1' (line 49)

Product build number.

VERSION = '2.0.6' (line 30)

Product Version : major.minor.maintenance [alphaX, betaX or rcX]

Documentation generated on Tue, 28 Sep 2010 10:36:43 +0200 by phpDocumentor 1.4.0a2