| [ Index ] |
PHP Cross Reference of Zikula 1.1.2 CORE |
[Source view] [Print] [Project Stats]
Zikula Application Framework
| Copyright: | (c) Zikula Development Team |
| License: | GNU/GPL - http://www.gnu.org/copyleft/gpl.html |
| Version: | $Id: pnAPI.php 25973 2009-07-02 05:51:51Z drak $ |
| File Size: | 1560 lines (48 kb) |
| Included or required: | 11 times |
| Referenced: | 0 times |
| Includes or requires: | 1 file includes/Loader.class.php |
| pnConfigGetVar($name, $default=null) X-Ref |
| get a configuration variable param: name $ the name of the variable param: default the default value to return if the requested param is not set return: mixed value of the variable, or false on failure |
| pnConfigSetVar($name, $value='') X-Ref |
| set a configuration variable param: name $ the name of the variable param: value $ the value of the variable return: bool true on success, false on failure |
| pnConfigDelVar($name) X-Ref |
| delete a configuration variable returns: mixed value of deleted config var or false on failure param: name $ the name of the variable |
| pnInit($stages = PN_CORE_ALL) X-Ref |
| Initialise Zikula <br /> Carries out a number of initialisation tasks to get Zikula up and running. returns: bool true initialisation successful false otherwise |
| pnDBInit() X-Ref |
| Initialise DB connection return: bool true if successful, false otherwise |
| pnDBGetConn($pass_by_reference = false, $fetchmode = ADODB_FETCH_NUM) X-Ref |
| get a list of database connections author: Eric Barr author: Roger Raymond param: bool $pass_by_reference default = false param: string $fetchmode set ADODB fetchmode ADODB_FETCH_NUM, ADODB_FETCH_ASSOC, ADODB_FETCH_DEFAULT, ADODB_FETCH_BOTH return: array array of database connections |
| pnDBGetTables() X-Ref |
| get a list of database tables author: Eric Barr author: Roger Raymond return: array array of database tables |
| pnDBGetTableOptions($tablename='') X-Ref |
| No description |
| pnDBSetTables() X-Ref |
| Set Database Table Listing author: Eric Barr param: array $newtables return: void |
| pnDBGetTablePrefix($table) X-Ref |
| get table prefix get's the database prefix for the current site In a non multisite scenario this will be the 'prefix' config var from config/config.php. For a multisite configuration the multistes module will manage the prefixes for a given table The table name parameter is the table name to get the prefix for minus the prefix and seperating _ e.g. pnDBGetPrefix returns pn_modules for pnDBGetPrefix('modules'); author: Mark West param: table - table name |
| pnVarCleanFromInput() X-Ref |
| clean user input Gets a global variable, cleaning it up to try to ensure that hack attacks don't work param: var $ name of variable to get param: $ ... return: mixed prepared variable if only one variable passed |
| pnStripslashes(&$value) X-Ref |
| strip slashes stripslashes on multidimensional arrays. Used in conjunction with pnVarCleanFromInput param: any $ variables or arrays to be stripslashed |
| pnVarPrepForDisplay() X-Ref |
| ready user output Gets a variable, cleaning it up such that the text is shown exactly as expected param: var $ variable to prepare param: $ ... return: mixed prepared variable if only one variable passed |
| pnVarPrepHTMLDisplay() X-Ref |
| ready HTML output Gets a variable, cleaning it up such that the text is shown exactly as expected, except for allowed HTML tags which are allowed through author: Xaraya development team param: var variable to prepare param: ... return: string/array prepared variable if only one variable passed |
| pnVarPrepForStore() X-Ref |
| ready database output Gets a variable, cleaning it up such that the text is stored in a database exactly as expected param: var $ variable to prepare param: $ ... return: mixed prepared variable if only one variable passed |
| pnVarPrepForOS() X-Ref |
| ready operating system output Gets a variable, cleaning it up such that any attempts to access files outside of the scope of the Zikula system is not allowed. param: var $ variable to prepare param: $ ... return: mixed prepared variable if only one variable passed |
| pnVarCensor() X-Ref |
| remove censored words |
| pnVarValidate($var, $type, $args = 0) X-Ref |
| validate a zikula variable author: Damien Bonvillain author: Gregor J. Rothfuss author: J�rg Napp param: $var the variable to validate param: $type the type of the validation to perform (email, url etc.) param: $args optional array with validation-specific settings (never used...) return: bool true if the validation was successful, false otherwise |
| pnGetStatusMsg() X-Ref |
| get status message from previous operation Obtains any status message, and also destroys it from the session to prevent duplication return: string the status message |
| pnGetBaseURI() X-Ref |
| get base URI for Zikula author: Martin Andersen return: string base URI for Zikula |
| pnGetBaseURL() X-Ref |
| get base URL for Zikula return: string base URL for Zikula |
| pnRedirect($redirecturl, $additionalheaders = array() X-Ref |
| Carry out a redirect returns: bool true if redirect successful, false otherwise param: string $redirecturl URL to redirect to param: array $addtionalheaders array of header strings to send with redirect |
| pnLocalReferer($strict = false) X-Ref |
| check to see if this is a local referral param: bool strict - strict checking ensures that a referer must be set as well as local return: bool true if locally referred, false if not |
| GetUserTime($time) X-Ref |
| get a Time String in the right format param: time $ - prefix string return: mixed string if successfull, false if not |
| pnMail($to, $subject, $message='', $headers = '', $html = 0, $debug = 0) X-Ref |
| send an email e-mail messages should now be send with a pnModAPIFunc call to the mailer module param: to $ - recipient of the email param: subject $ - title of the email param: message $ - body of the email param: headers $ - extra headers for the email param: html $ - message is html formatted param: debug $ - if 1, echo mail content return: bool true if the email was sent, false if not |
| pnPhpVersionCheck($vercheck='') X-Ref |
| Function that compares the current php version on the system with the target one Deprecate function reverting to php detecion function |
| pnADODBInit() X-Ref |
| initialise ADODB return: void |
| pnServerGetVar($name, $default=null) X-Ref |
| Gets a server variable Returns the value of $name from $_SERVER array. Accepted values for $name are exactly the ones described by the {@link http://www.php.net/manual/en/reserved.variables.html#reserved.variables.server PHP manual}. If the server variable doesn't exist void is returned. author: Marco Canini <marco@xaraya.com>, Michel Dalle param: name string the name of the variable param: default the default value to return if the requested param is not set return: mixed value of the variable |
| pnGetHost() X-Ref |
| Gets the host name Returns the server host name fetched from HTTP headers when possible. The host name is in the canonical form (host + : + port) when the port is different than 80. author: Marco Canini <marco@xaraya.com> return: string HTTP host name |
| pnGetCurrentURI($args = array() X-Ref |
| Get current URI (and optionally add/replace some parameters) param: args array additional parameters to be added to/replaced in the URI (e.g. theme, ...) return: string current URI |
| pnServerGetProtocol() X-Ref |
| Gets the current protocol Returns the HTTP protocol used by current connection, it could be 'http' or 'https'. author: Marco Canini <marco@xaraya.com> return: string current HTTP protocol |
| pnGetCurrentURL() X-Ref |
| Get current URL param: args array additional parameters to be added to/replaced in the URL (e.g. theme, ...) return: string current URL |
| pnQueryStringDecode() X-Ref |
| Decode the path string into a set of variable/value pairs available via pnVarCleanFromInput or the object libary This API works in conjunction with the new short urls system to extract a path based variable set into the Get, Post and request superglobals. A sample path is /modname/function/var1:value1 author: Martin Andersen author: Mark West |
| pnQueryStringSetVar($name, $value) X-Ref |
| add a variable/value pair into the query string (really the _GET superglobal This API also adds the variable to the _REQUEST superglobal for consistentcy author: Mark West return: bool true if successful, false otherwise |
| pnErrorHandler($errno, $errstr, $errfile, $errline, $errcontext) X-Ref |
| No description |
| pnShutDown($exit_param='') X-Ref |
| Gracefully shut down the framework (traps all exit and die calls) author: drak param: $exit_param params to pass to the exit function return: none - function halts execution |
| Generated: Fri Aug 21 20:39:03 2009 | Cross-referenced by PHPXref 0.7 |