-
_access_denied
-
Show a helpful access-denied page. Has a login ability if it senses that logging in could curtail the error.
-
_access_string
-
Convert an integer permission to the string version.
-
_ad
-
Standard modular UI/actualiser to add an entry.
-
_box_callback
-
Make boxes readable. Callback for preg_replace_callback.
-
_build_keep_form_fields
-
Get hidden fields for a form representing 'keep_x'. If we are having a GET form instead of a POST form, we need to do this. This function also encodes the page name, as we'll always want that.
-
_build_keep_post_fields
-
Relay all POST variables for this URL, to the URL embedded in the form.
-
_build_url
-
Build and return a proper URL, from the $vars array.
-
_check_enforcement_of_type
-
Ensures a given filename is of the right file extension for the desired file type.
-
_check_sizes
-
Check a set of fields aren't going to exceed key limits.
-
_choose_moniker
-
Delete an old moniker, and place a new one.
-
_comcode_lang_string
-
Convert a language string that is Comcode to tempcode, with potential cacheing in the db.
-
_convert_url_to_path
-
Convert a URL to a local file path.
-
_css_compile
-
Return a specific compiled CSS file.
-
_css_ocp_include
-
preg_replace callback, to handle CSS file inclusion.
-
_deldir_contents
-
Delete all the contents of a directory, and any subdirectories of that specified directory (recursively).
-
_diff_simple
-
-
_do_lang
-
Get the human-readable form of a language id, or a language entry from a language INI file.
-
_do_template
-
A template has not been structurally cached, so compile it and store in the cache.
-
_ed
-
Standard modular UI to edit an entry.
-
_edit
-
Actualiser to edit/send/delete an email.
-
_enforce_sessioned_url
-
Make sure that the given URL contains a session if cookies are disabled.
-
_export_table_to_xml
-
Export an ocPortal database table to an equivalent XML format.
-
_fatal_exit
-
Do a fatal exit, echo the header (if possible) and an error message, followed by a debugging back-trace.
-
_find_all_langs
-
Get an array of all the installed languages that can be found in root/lang/ and root/lang_custom/
-
_find_all_modules
-
Get an array of all the modules.
-
_find_all_pages
-
Get an array of all the pages of the specified type (module, etc) and extension (for small sites everything will be returned, for larger ones it depends on the show method).
-
_find_all_pages_wrap
-
Get an array of all the pages everywhere in the zone (for small sites everything will be returned, for larger ones it depends on the show method).
-
_find_text_file_path
-
Helper function for *_text_file
-
_fixup_protocolless_urls
-
Sometimes users don't enter full URLs but do intend for them to be absolute. This code tries to see what relative URLs are actually absolute ones, via an algorithm. It then fixes the URL.
-
_ftp_info
-
Return the FTP connection, from stored/posted details.
-
_general_db_init
-
Called once our DB connection becomes active.
-
_generic_exit
-
Do a terminal execution on a defined page type
-
_get_block_path
-
Gets the path to a block code file for a block code name
-
_get_dir_tree
-
Get a list of files under a directory.
-
_get_input_date
-
Check a POST inputted date for validity, and get the Unix timestamp for the inputted date.
-
_get_lang_file_map
-
Extend a language map from strings in a given language file.
-
_get_module_path
-
Get the path to a module known to be in a certain zone.
-
_get_specify_url
-
Filters specified URLs to make sure we're really allowed to access them.
-
_get_upload_url
-
Converts an uploaded file into a URL, by moving it to an appropriate place.
-
_get_where_clause_groups
-
Get the SQL WHERE clause to select for any the given member is in (gets combined with some condition, to check against every).
-
_get_where_expand
-
Create a SELECT query from some abstract data.
-
_give_moniker_scope
-
Take a moniker and it's page link details, and make a full path from it.
-
_handle_permission_check_logging
-
Log permission checks to the permission_checks.log file
-
_helper_add_table_field
-
Adds a field to an existing table.
-
_helper_alter_table_field
-
Change the type of a DB field in a table. Note: this function does not support ascession/decession of translatability
-
_helper_change_primary_key
-
Change the primary key of a table.
-
_helper_create_index
-
Add an index to a table without disturbing the contents, after the table has been created.
-
_helper_create_table
-
Create a table with the given name and the given array of field name to type mappings.
-
_helper_delete_index_if_exists
-
Delete an index from a table.
-
_helper_delete_table_field
-
Delete the specified field from the specified table.
-
_helper_drop_if_exists
-
Drop the given table, or if it doesn't exist, silently return.
-
_helper_promote_text_field_to_comcode
-
If a text field has picked up Comcode support, we will need to run this.
-
_helper_refresh_field_definition
-
If we've changed what $type is stored as, this function will need to be called to change the typing in the DB.
-
_helper_rename_table
-
Rename the given table.
-
_http_download_file
-
Return the file in the URL by downloading it over HTTP. If a byte limit is given, it will only download that many bytes. It outputs warnings, returning NULL, on error.
-
_indent_callback
-
Indent text lines. Callback for preg_replace_callback.
-
_insert_lang
-
Insert a language entry into the translation table, and returns the id.
-
_inspect
-
Output whatever arguments are given for debugging. If possible it'll output with plain text, but if output has already started it will attach messages.
-
_keyword_match
-
See if a string matches one of the keywords.
-
_lang_remap
-
Remap the specified language id, and return the id again - the id isn't changed.
-
_length_so_far
-
Helper function or use getting line numbers.
-
_load_comcode_page_cache_off
-
Load Comcode page from disk.
-
_load_comcode_page_not_cached
-
Load Comcode page from disk, then cache it.
-
_log_hack_attack_and_exit
-
Log a hackattack, then displays an error message. It also attempts to send an e-mail to the staff alerting them of the hackattack.
-
_log_it
-
Log an action
-
_mail_css_rep_callback
-
Replace CSS image references such that it is cid'd. Callback for preg_replace_callback.
-
_mail_img_rep_callback
-
Replace an HTML img tag such that it is cid'd. Callback for preg_replace_callback.
-
_mark_all_as_escaped
-
Recursively mark all parameters in this Tempcode as escaped. This is needed when loading from cache, as escape tainting data would have been lost.
-
_nice_get_langs
-
Get a nice formatted XHTML listed language selector.
-
_ocfilter_eq
-
Helper function to generate an SQL "equal to" fragment.
-
_ocfilter_find_ids_and_parents
-
Helper function to fetch a subtree from the database.
-
_ocfilter_neq
-
Helper function to generate an SQL "not equal to" fragment.
-
_ocfilter_subtree_fetch
-
Helper function to fetch a subtree from the database.
-
_ocfilter_to_generic
-
Turn an ocFilter (a filter specifying which records to match) into a list of ID numbers, relying on the database to extract the record-set.
-
_ocfilter_to_generic_callback
-
Function to do an actual data lookup sourced via the database, used as a kind of a callback function (it's name gets passed into the generic API).
-
_ocportal_error_handler
-
Called by 'ocportal_error_handler'. ocPortal error handler (hooked into PHP error system).
-
_page_path_to_pagelink
-
Convert a local page file path to a written page-link.
-
_param_invalid
-
Handle invalid parameter values.
-
_qualify_url
-
Take a URL and base-URL, and fully qualify the URL according to it.
-
_query
-
This function is a very basic query executor. It shouldn't usually be used by you, as there are specialised abstracted versions available.
-
_query_value
-
Extract the first of the first of the list of maps.
-
_request_page
-
Take the specified parameters, and try to find the corresponding page
-
_rescope_path
-
Rescope an ocPortal path to a path suitable for the AFM connection.
-
_search_img_file
-
Search for a specified image file within a theme for a specified language.
-
_smart_grammar_says_continue
-
XHTML-aware helper function to try and get to a nice grammatical point to call our substring termius.
-
_smart_grammar_says_futile
-
XHTML-aware helper function to try and get to a nice grammatical point to call our substring termius.
-
_splurgh_do_node
-
Build up the splurgh nodes recursively for given details.
-
_strip_junk_words
-
Strip junk words from the keywords representing a search.
-
_sync_file_move
-
Provides a hook for file-move synchronisation between mirrored servers. Called after any rename or move action.
-
_synonyms
-
Get synonyms for ocPortal terminology.
-
_tab
-
Add one layer of tabbing to some XML.
-
_title_callback
-
Make titles readable. Callback for preg_replace_callback.
-
_translate_dir_access
-
Translate truth about needing world write access to a directory to absolute permissions.
-
_translate_file_access
-
Translate truth about needing world write access to a file to absolute permissions.
-
_urlise_lang
-
URL'ise specially encoded text-acceptance language strings.
-
_url_rewrite_params
-
Attempt to use mod_rewrite to improve this URL.
-
_url_to_filename
-
Takes a URL, and converts it into a file system storable filename. This is used to cache URL contents to the servers filesystem.
-
_url_to_pagelink
-
Convert a local URL to a page-link.
-
_xml_rpc_type_convert
-
Convert some data to XML-RPC format.
-
__construct
-
-
__ed
-
Standard modular UI/actualiser to edit an entry.
-
__param
-
Helper function to load up a GET/POST parameter.
-
__sleep
-
PHP magic function to handle serialisation.
-
$cached_output
-
-
$care_please
-
-
$catalogue
-
-
$cat_aed_module
-
-
$check_validation
-
-
$children_stack
-
-
$codename
-
-
$code_require
-
-
$code_to_preexecute
-
-
$connection
-
-
$connection_read
-
-
$connection_write
-
-
cacheing_environment
-
Standard modular cache function.
-
cacheing_environment
-
Standard modular cache function.
-
cacheing_environment
-
Standard modular cache function.
-
cacheing_environment
-
Standard modular cache function.
-
cache_module_installed_status
-
Look up and remember what modules are installed.
-
can_arbitrary_groupby
-
Find whether the database may run GROUP BY unfettered with restrictions on the SELECT'd fields having to be represented in it or aggregate functions
-
can_try_mod_rewrite
-
Find if mod_rewrite is in use
-
catch_fatal_errors
-
ocPortal error catcher for fatal versions. This is hooked in only on PHP5.2 as error_get_last() only works on these versions.
-
cdn_filter
-
Filter a path so it runs through a CDN.
-
ce_do_footer
-
Output the config editors page footer.
-
ce_do_header
-
Output the config editors page header.
-
ce_do_login
-
Output a login page.
-
change_detection_script
-
AJAX script to tell if data has been changed.
-
change_primary_key
-
Change the primary key of a table.
-
check_cache
-
-
check_delete_permission
-
Check if a member's has permission to delete a specific resource. If it doesn't, an error message is outputted.
-
check_edit_permission
-
Check to see if a member's has permission to edit an item. If it doesn't, an error message is outputted.
-
check_extension
-
Check uploaded file extensions for possible malicious intent, and if some is found, an error is put out, and the hackattack logged.
-
check_gzip_use
-
-
check_memory_limit_for
-
Check we can load the given file, given our memory limit.
-
check_posted_field
-
Check a posted field isn't 'evil'.
-
check_shared_bandwidth_usage
-
Check bandwidth usage against page view ratio for shared hosting.
-
check_shared_space_usage
-
Check disk space usage against page view ratio for shared hosting.
-
check_some_edit_permission
-
Check to see if a member's has permission to edit an item. If it doesn't, an error message is outputted.
-
check_specific_permission
-
Require presence of a permission for the current member; otherwise exit.
-
check_submit_permission
-
Check to see if a member's has permission to submit an item. If it doesn't, an error message is outputted.
-
check_word_filter
-
Check the specified text ($a) for banned words.
-
choose_catalogue
-
Get some XHTML for a form to choose a catalogue out of all the available ones.
-
choose_language
-
UI to choose a language.
-
cleanup_block_name
-
Make a block codename look nice
-
cleanup_date
-
Convert an ISO date into a timestamp.
-
clean_file_size
-
Format the specified filesize.
-
clean_html_title
-
Turn an HTML title, which could be complex with images, into a nice simple string we can use in <title> and ;.
-
clear_ocp_autosave
-
Declare that an action succeeded - delete safety autosave cookies.
-
clear_old_uploads
-
Function to clear old uploads, that are older then 2 days
-
closed_site
-
Render the site as closed.
-
closure_eval
-
Evaluate some PHP code to put the result into an expression (code is allowed to have side effects).
-
closure_loop
-
Perform a simple loop, that can be inlined in an expression.
-
closure_while_loop
-
Perform a simple loop, that can be inlined in an expression.
-
cms.php
-
-
collapse_1d_complexity
-
Take a list of maps of just one element, and make it into a single map
-
collapse_2d_complexity
-
Take a list of maps of just two elements, and make it into a single map
-
comcode_breadcrumbs
-
Get a UI element of a route from a known Comcode page back to the declared root of the tree.
-
comcode_convert_script
-
AJAX script for HTML<>Comcode conversion (and Comcode-Text>Comcode-XML).
-
comcode_lang_string
-
Convert a language string that is Comcode to tempcode, with potential cacheing in the db.
-
comcode_to_clean_text
-
Make some Comcode more readable.
-
compare_ip_address
-
Compare two IP addresses for potential correlation. Not as simple as equality due to '*' syntax.
-
compare_ip_address_ip4
-
Compare two IP addresses for potential correlation. Not as simple as equality due to '*' syntax. IP4-only variant
-
compare_ip_address_ip6
-
Compare two IP addresses for potential correlation. Not as simple as equality due to '*' syntax. IP6-only variant
-
compile_template
-
Compile a template into a list of appendable outputs, for the closure-style Tempcode implementation.
-
compressor
-
-
Compressor
-
**** <external entry point>
-
compress_javascript
-
-
concede
-
The actualiser for entering conceded mode.
-
config_editor.php
-
-
config_option_exists
-
Check if a config option exists.
-
confirm_session_script
-
AJAX script for confirming a session is active.
-
convert_data_encodings
-
Performs lots of magic to make sure data encodings are converted correctly. Input, and output too (as often stores internally in UTF or performs automatic dynamic conversions from internal to external charsets).
-
convert_image
-
Resize an image to the specified size, but retain the aspect ratio.
-
convert_to_internal_encoding
-
Convert some data from one encoding to the internal encoding.
-
convert_url_to_path
-
Convert a URL to a local file path.
-
cookie_login
-
Do a cookie login.
-
co_sync_file
-
Provides a hook for file synchronisation between mirrored servers.
-
co_sync_file_move
-
Provides a hook for file synchronisation between mirrored servers.
-
crc32_file
-
Calculate CRC32 for a file. Based on a function in the PHP docs.
-
create_index
-
Add an index to a table without disturbing the contents, after the table has been created.
-
create_session
-
Set up a new session / Restore an existing one that was lost.
-
create_table
-
Create a table with the given name and the given array of field name to type mappings.
-
create_zip_file
-
Create a zip file.
-
critical_error
-
Exit with a nicely formatted critical error.
-
cron_bridge_script
-
Script to perform ocPortal CRON jobs called by the real CRON.
-
cron_installed
-
Find if Cron is installed
-
css_compile
-
Compile a CSS file.
-
css_enforce
-
Force a CSS file to be cached.
-
css_inherit
-
Inerit from a CSS file to create a string for a (possibly theme-gen) modified version of that file.
-
css_minify
-
Minifies stylesheet definitions
-
css_tempcode
-
Get tempcode to tie in (to the HTML, in <head>) all the CSS files that have been required.
-
current_share_user
-
Find the user-ID of the current shared-site install from the accessing URL. This should only ever be called when it is known a shared-site is in operation
-
confirm_session.php
-
-
cron_bridge.php
-
-
caches.php
-
-
caches2.php
-
-
caches_apc.php
-
-
caches_eaccelerator.php
-
-
caches_filesystem.php
-
-
caches_wincache.php
-
-
caches_xcache.php
-
-
character_sets.php
-
-
config.php
-
-
config2.php
-
-
critical_errors.php
-
-
css_and_js.php
-
-
core.php
-
-
check_broken_urls.php
-
-
collapse_user_zones.php
-
-
core.php
-
-
$default_type
-
-
$do_next_description
-
-
$do_next_editing_categories
-
-
$do_preview
-
-
database_driver
-
-
database_driver
-
Construct a database driver from connection parameters.
-
db_encode_like
-
Encode a LIKE string comparision fragement for the database system. The pattern is a mixture of characters and ? and % wilcard symbols.
-
db_escape_string
-
Escape a string so it may be inserted into a query. If SQL statements are being built up and passed using db_query then it is essential that this is used for security reasons. Otherwise, the abstraction layer deals with the situation.
-
db_full_text_assemble
-
Assemble part of a WHERE clause for doing full-text search
-
db_get_first_id
-
Get the ID of the first row in an auto-increment table (used whenever we need to reference the first).
-
db_has_expression_ordering
-
Find whether expression ordering support is present
-
db_has_full_text
-
Find whether full-text-search is present
-
db_has_subqueries
-
Find whether subquery support is present
-
db_like_assemble
-
Generate SQL for a boolean search.
-
db_string_equal_to
-
Encode an SQL statement fragment for a conditional to see if two strings are equal.
-
db_string_not_equal_to
-
Encode an SQL statement fragment for a conditional to see if two strings are not equal.
-
decache
-
Remove an item from the general cache (most commonly used for blocks).
-
decache
-
Decache the object.
-
decrypt_data
-
Decrypt data using asymmetric encryption, and the site's private key (as unlocked by the given passphrase).
-
deldir_contents
-
Delete all the contents of a directory, and any subdirectories of that specified directory (recursively).
-
delete
-
(Plug-in replacement for memcache API) Delete data from the persistant cache.
-
delete
-
(Plug-in replacement for memcache API) Delete data from the persistant cache.
-
delete
-
(Plug-in replacement for memcache API) Delete data from the persistant cache.
-
delete
-
(Plug-in replacement for memcache API) Delete data from the persistant cache.
-
delete
-
(Plug-in replacement for memcache API) Delete data from the persistant cache.
-
delete_attachments
-
Delete attachments solely used by the specified hook.
-
delete_config_option
-
Deletes a specified config option permanently from the database.
-
delete_expired_sessions
-
Find what sessions are expired and delete them.
-
delete_index_if_exists
-
Delete an index from a table.
-
delete_lang
-
Delete the specified language entry from the translation table.
-
delete_specific_permission
-
Delete a specific-permission, and every usergroup is then relaxed from the restrictions of this permission.
-
delete_table_field
-
Delete the specified field from the specified table.
-
delete_upload
-
Delete an uploaded file from disk, if it's URL has changed (i.e. it's been replaced, leaving a redundant disk file).
-
delete_value
-
Delete a situational value.
-
deshout_callback
-
preg_replace callback to de-shout text.
-
destrictify
-
Remove ocPortal's strictness, to help integration of third-party code.
-
die_html_trace
-
Echo an error message, and a debug back-trace of the current execution stack. Use this for debugging purposes.
-
diff_compute_new
-
-
diff_simple
-
-
diff_simple_2
-
-
directive_tempcode
-
This will create a new tempcode object that is containing a single specifed directive
-
disable_php_memory_limit
-
Disable the PHP memory limit. Do not use this carelessly, use it if a screen is a bit fat or in an importer, don't use it assuming memory is infinite.
-
disable_staff_filter
-
If we can't get a list of admins via a usergroup query, we have to disable the staff filter - else the staff filtering can cause disaster at the point of being turned on (because it can't automatically sync).
-
display_time_period
-
Display a time period in a tidy human-readable way.
-
display_validation_results
-
Show results of running a validation function.
-
div
-
Get the tempcode for a div. Similar to paragraph, but may contain more formatting (such as
's)
-
does_lang_exist
-
Find whether the specified language exists.
-
do_access
-
Output the editing page.
-
do_block
-
Get the processed tempcode for the specified block. Please note that you pass multiple parameters in as an array, but single parameters go in as a string or other flat variable.
-
do_block_get_cache_identifier
-
Takes a string which is a PHP expression over $map (parameter map), and returns a derived identifier.
-
do_block_hunt_file
-
Get the block object for a given block codename.
-
do_environment_utf8_conversion
-
Do a UTF8 conversion on the environmental GET/POST parameters.
-
do_footer
-
Get the tempcode for the footer. You will not normally need to use this function, as this is called as part of the website engine.
-
do_header
-
Get the tempcode for the header. You will not normally need to use this function, as this is called as part of the website engine.
-
do_image_thumb
-
Get the tempcode for an image thumbnail.
-
do_lang_tempcode
-
This will create a new tempcode object that is containing a single specifed language code
-
do_next_manager
-
The do-next manager for after content management.
-
do_set
-
Do the editing.
-
do_simple_environment_utf8_conversion
-
Do a UTF8 conversion on the environmental GET/POST parameters (ISO-8859-1 charset, which PHP supports internally).
-
do_site
-
This is it - the start of rendering of a website page.
-
do_template
-
Get a tempcoded version of a normal XHTML template. It is perhaps the most common ocPortal function to load up templates using do_template, and then attach them together either as parameters to each other, or via the tempcode attach method.
-
do_xhtml_validation
-
Takes the output from the scripts, and check the XHTML for validity, then echoes the page, plus the validation results.
-
drop_if_exists
-
Drop the given table, or if it doesn't exist, silently return.
-
dump
-
Dumps key and variable to firebug server panel
-
database.php
-
-
database_action.php
-
-
database_helper.php
-
-
database_search.php
-
-
developer_tools.php
-
-
diff.php
-
-
$feed_url
-
-
$field_qualification_stack
-
-
find_permissions.php
-
-
force_sitemap_generation.php
-
-
fallback_lang
-
This function is called when no other language works, and it will return the original default language - 'EN'. You may change this to another language, but this is not advised, as ocPortal is being shipped with the EN language complete and unabridged as standard - hence you cannot go wrong if you leave it as EN.
-
fast_uniqid
-
The PHP uniqid function is slow on some PHP versions. This version is much faster.
-
fatal_exit
-
Do a fatal exit, echo the header (if possible) and an error message, followed by a debugging back-trace.
-
FB
-
-
fb
-
Sends the given data to the FirePHP Firefox Extension.
-
field_restriction_loader
-
-
filecache
-
-
FILE_BINARY
-
-
file_get_contents
-
Get the contents of a file.
-
file_get_contents
-
-
file_put_contents
-
-
file_size_to_tar_block_size
-
Return the output from the conversion between filesize and TAR block size.
-
FILE_TEXT
-
-
filter_css
-
Filter out any CSS selector blocks from the given CSS if they definitely do not affect the given (X)HTML.
-
filter_form_field_default
-
Filter to alter form field values based on fields.xml. Usually a no-op.
-
filter_naughty
-
Get the parameter put into it, with no changes. If it detects that the parameter is naughty (i.e malicious, and probably from a hacker), it will log the hack-attack and output an error message.
-
filter_naughty_harsh
-
This function is similar to filter_naughty, except it requires the parameter to be strictly alphanumeric. It is intended for use on text that will be put into an eval.
-
find_all_blocks
-
Get an array of all the blocks that are currently installed.
-
find_all_hooks
-
Get an array of all the hook implementations for a hook class.
-
find_all_langs
-
Get an array of all the installed languages that can be found in root/lang/ and root/lang_custom/
-
find_all_modules
-
Get an array of all the modules.
-
find_all_pages
-
Get an array of all the pages of the specified type (module, etc) and extension (for small sites everything will be returned, for larger ones it depends on the show method).
-
find_all_pages_wrap
-
Get an array of all the pages everywhere in the zone, limited by the selection algorithm (for small sites everything will be returned, for larger ones it depends on the show method).
-
find_all_xml_tables
-
Find a list of all the tables that can be imported/exported as XML.
-
find_all_zones
-
Find the installed zones, up to the first 50 installed
-
find_cache_on
-
Find the cache-on parameters for 'codename's cacheing style (prevents us needing to load up extra code to find it).
-
find_id_moniker
-
Find the textual moniker for a typical ocPortal URL path. This will be called from inside build_url, based on details learned from a moniker hook (only if a hook exists to hint how to make the requested link SEO friendly).
-
find_lost_option
-
An option has dissappeared somehow - find it via searching our code-base for it's install code. It doesn't get returned, just loaded up. This function will produce a fatal error if we cannot find it.
-
find_permissions_script
-
AJAX script for finding out specific permissions for the queried resource.
-
find_script
-
Find the URL to a certain external handler script (ocPortal allows these to be moved around between zones, to suit site .htaccess requirements).
-
find_security_alerts
-
Get a results table showing security alerts matching WHERE constraints.
-
find_template_path
-
Finds the path of the given template codename.
-
find_template_place
-
Search for a template.
-
find_template_tree_nice
-
Convert a template tree structure into a HTML representation.
-
find_theme_image
-
Find the URL to the theme image of the specified ID. It searches various priorities, including language and theme overrides.
-
FirePHP_DUMP
-
Dumps a variable to firebug's server panel
-
FirePHP_ERROR
-
Firebug ERROR level
-
FirePHP_GROUP_END
-
Ends a group in firebug console
-
FirePHP_GROUP_START
-
Starts a group in firebug console
-
FirePHP_INFO
-
Firebug INFO level
-
FirePHP_LOG
-
Firebug LOG level
-
FirePHP_TABLE
-
Displays a table in firebug console
-
FirePHP_TRACE
-
Displays a stack trace in firebug console
-
FirePHP_VERSION
-
FirePHP version
-
FirePHP_WARN
-
Firebug WARN level
-
fixup_protocolless_urls
-
Sometimes users don't enter full URLs but do intend for them to be absolute. This code tries to see what relative URLs are actually absolute ones, via an algorithm. It then fixes the URL.
-
fix_permissions
-
Ensure that the specified file/folder is writeable for the FTP user (so that it can be deleted by the system), and should be called whenever a file is uploaded/created, or a folder is made. We call this function assuming we are giving world permissions
-
flatten_slashed_array
-
Turn an array into a humanely readable string.
-
float_format
-
Format the given float number as a nicely formatted string.
-
float_to_raw_string
-
Convert a float to a "technical string representation of a float".
-
flush
-
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
-
flush
-
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
-
flush
-
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
-
flush
-
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
-
flush
-
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
-
force_have_afm_details
-
Make sure that the AFM connection details have been posted. If not, get them and loop back.
-
force_httpauth
-
Force an HTTP authentication login box / relay it as if it were a posted login. This function is rarely used.
-
form_input_hidden
-
Get the tempcode for a hidden form element.
-
form_input_list_entry
-
Get the tempcode for a list entry. (You would gather together the outputs of several of these functions, then put them in as the $content in a form_input_list function call).
-
form_to_email
-
Send the posted form over email to the staff address.
-
form_to_email_entry_script
-
Entry script to process a form that needs to be emailed.
-
forum_driver_base
-
-
forum_link
-
Get a URL to a forum.
-
fractional_edit
-
Find whether a fractional edit is underway.
-
fractional_edit_script
-
AJAX script to make a fractional edit to some data.
-
from_assembly
-
The opposite of to_assembly - it decodes a tempcode storage representation and turns it into a proper tempcode object.
-
from_assembly_executed
-
The opposite of to_assembly - it decodes a tempcode storage representation and turns it into a proper tempcode object. This version handles the result of evaled code.
-
forums.php
-
-
failure.php
-
-
files.php
-
-
files2.php
-
-
firephp.php
-
-
forum_stub.php
-
-
filesystem_caching.php
-
-
forums.php
-
-
$gleamed
-
-
$gleamed_feed
-
-
$gleamed_items
-
-
geolocate_ip
-
Find the country an IP address long is located in
-
get
-
(Plug-in replacement for memcache API) Get data from the persistant cache.
-
get
-
(Plug-in replacement for memcache API) Get data from the persistant cache.
-
get
-
(Plug-in replacement for memcache API) Get data from the persistant cache.
-
get
-
(Plug-in replacement for memcache API) Get data from the persistant cache.
-
get
-
Get the next stream token
-
get
-
(Plug-in replacement for memcache API) Get data from the persistant cache.
-
getEnabled
-
Check if logging is enabled
-
getOptions
-
Get options for the library
-
get_afm_form
-
Force an AFM login.
-
get_afm_form_fields
-
Get the fields that need to be filled in to know how to do an AFM connection.
-
get_base_url
-
Get the base url (the minimum fully qualified URL to our installation).
-
get_block_parameters
-
Gets parameters for a block
-
get_bot_type
-
Get the name of a webcrawler bot, or NULL if no bot detected
-
get_browser_string
-
Get a string of the users web browser
-
get_cache_entry
-
Find the cached result of what is named by codename and the further constraints.
-
get_category_permissions_for_environment
-
Gather the permissions for the specified category as a form field input matrix.
-
get_charset
-
Get the character set to use. We try and be clever to allow AJAX scripts to avoid loading up language
-
get_chmod_array
-
Get a list of file permissions to set
-
get_chmod_array
-
Get the list of files that need CHmodding for write access.
-
get_comcode_zone
-
Find the zone a comcode page is in.
-
get_complex_base_url
-
Function to get a base URL for an OCF relative-URL. The situation is complex as it needs to take into account OCF multi-site-network's, locally defined theme images, and shared-installs (myocp style).
-
get_content
-
-
get_cookie_days
-
Get the number of days to store our cookies.
-
get_cookie_domain
-
Get the ocPortal cookie domain.
-
get_cookie_path
-
Get the ocPortal cookie path.
-
get_css_content
-
-
get_custom_base_url
-
Get the base url (the minimum fully qualified URL to our personal data installation). For a shared install only, this is different to the base-url.
-
get_custom_file_base
-
Get the file base for your installation of ocPortal. For a shared install only, this is different to the base-url.
-
get_db_forums
-
Get the name of the forum database.
-
get_db_forums_host
-
Get the host of the forum database ('localhost', for example).
-
get_db_forums_password
-
Get the forum database password.
-
get_db_forums_user
-
Get the forum database username.
-
get_db_keywords
-
Returns a list of keywords for all databases we might some day support.
-
get_db_site
-
Get the name of the database.
-
get_db_site_host
-
Get the host of the database ('localhost', for example).
-
get_db_site_password
-
Get the database password.
-
get_db_site_user
-
Get the database username.
-
get_db_type
-
Get the type of database installed, such as MySQL, or Oracle.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_default
-
Gets the default value for the config option.
-
get_dependencies
-
Get a mapping of dependency types
-
get_description
-
Get the description of the addon
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_details
-
Gets the details relating to the config option.
-
get_directory_contents
-
Get the contents of a directory, recursively. It is assumed that the directory exists.
-
get_directory_size
-
Get the size in bytes of a directory. It is assumed that the directory exists.
-
get_domain
-
Get the domain the website is installed on (preferably, without any www). The domain is used for e-mail defaults amongst other things.
-
get_entry_points
-
Standard modular entry-point finder function.
-
get_entry_points
-
Standard modular entry-point finder function.
-
get_entry_points
-
Standard modular entry-point finder function.
-
get_entry_points
-
Standard modular entry-point finder function.
-
get_entry_points
-
Standard modular entry-point finder function.
-
get_entry_points
-
Standard modular entry-point finder function.
-
get_entry_points
-
Standard modular entry-point finder function.
-
get_entry_points
-
Standard modular entry-point finder function.
-
get_false_permissions
-
Returns a list of pairs, for which permissions are false by default for ordinary usergroups.
-
get_file_base
-
Get the file base for your installation of ocPortal
-
get_file_extension
-
Get the file extension of the specified file. It returns without a dot.
-
get_file_list
-
Get a list of files that belong to this addon
-
get_file_size
-
Get a formatted-string filesize for the specified file. It is formatted as such: x Mb/Kb/Bytes (or unknown). It is assumed that the file exists.
-
get_flagrant
-
Get the XHTML for the flagrant text message.
-
get_forum_base_url
-
Get the installed forum base URL.
-
get_forum_type
-
Get the type of forums installed.
-
get_function_hash
-
Find the MD5 hash of the space-stripped copy of function within the given code.
-
get_future_version_information
-
Get information about new versions of ocPortal (or more accurately, what's wrong with this version).
-
get_gd_version
-
Get the version number of GD on the system. It should only be called if GD is known to be on the system, and in use
-
get_guest_group
-
Find the usergroup id of the forum guest member.
-
get_html_content
-
-
get_html_trace
-
Return a debugging back-trace of the current execution stack. Use this for debugging purposes.
-
get_input_date
-
Check a POST inputted date for validity, and get the Unix timestamp for the inputted date.
-
get_ip_address
-
Attempt to get the IP address of the current user
-
get_javascript_content
-
-
get_lang
-
Get the current language.
-
get_lang_browser
-
Get the closest fit language code to what the browser is requesting.
-
get_lang_files
-
Get a list of languages files for the given language. ONLY those that are overridden.
-
get_lang_file_descriptions
-
Get an array of all the INI description entries in the specified language.
-
get_lang_file_map
-
Get an array of all the INI language entries in the specified language.
-
get_lang_forum_user
-
Get what language the given member uses. The language is sent through a mapping to ensure it is in the right format, or dumped if it will not map.
-
get_loaded_tags
-
Get Tempcode for tags, based on loaded up from SEO keywords (seo_meta_load_for).
-
get_logo_url
-
Get the relative URL to the logo for the current zone.
-
get_long_value
-
Find a specified long value.
-
get_long_value_newer_than
-
Find the specified configuration option if it is younger than a specified time.
-
get_max_file_size
-
Get the maximum allowed upload filesize, as specified in the configuration
-
get_max_image_size
-
Get the maximum allowed image size, as set in the configuration.
-
get_member
-
Get the ID of the currently active member.
-
get_members_groups
-
Get a list of usergroups a member is in.
-
get_members_viewing
-
Get a map of members viewing the specified ocPortal location.
-
get_member_cookie
-
Get the member cookie's name.
-
get_member_email_address
-
Get a member's e-mail address.
-
get_microtime
-
-
get_mime_type
-
Find the mime type for the given file extension. It does not take into account whether the file type has been white-listed or not, and returns a binary download mime type for any unknown extensions.
-
get_moderator_groups
-
Get a list of the moderator usergroups.
-
get_module_overridables
-
Get a list of overridable SP's for a module.
-
get_module_zone
-
Find the zone a page is in.
-
get_num_new_forum_posts
-
Get the number of new forum posts on the system in the last 24 hours.
-
get_num_users_peak
-
Get the largest amount of users ever to be on the site at the same time.
-
get_num_users_site
-
Get the number of users on the site in the last 5 minutes. The function also maintains the statistic via the sessions table.
-
get_ocp_cpf
-
Get the value of a special 'ocp_' custom profile field.
-
get_online_members
-
Get database rows of all the online members.
-
get_option
-
Find the value of the specified configuration option.
-
get_os_string
-
Get the user's operating system
-
get_page_name
-
Get the name of the current page
-
get_page_permissions_for_environment
-
Gather the permissions for the specified page as form field inputs.
-
get_page_title
-
Get the tempcode for a page title. (Ones below the page header, not in the browser title bar.)
-
get_page_warning_details
-
A page is not validated, so show a warning.
-
get_page_zone
-
Find the zone a page is in.
-
get_param
-
Get the value of the specified GET key, if it is found, or the default otherwise.
-
get_param_integer
-
This function is the integeric partner of get_param, as it returns the value as an integer.
-
get_pass_cookie
-
Get the member password cookie's name.
-
get_permissions_matrix
-
Create a form field input matrix for permission setting.
-
get_permission_fields
-
Standard modular permission chooser.
-
get_rand_password
-
Get a randomised password.
-
get_relative_timezone
-
Get the relative timezone in order to calculate user time. The relative timezone takes into account both the website's offset from the server time, and the user's offset from the website's time.
-
get_remappings
-
Find the list of URL remappings
-
get_search_rows
-
Get some rows, queried from the database according to the search parameters.
-
get_self_url
-
Get a well formed URL equivalent to the current URL.
-
get_self_url_easy
-
Get a well formed URL equivalent to the current URL. Reads direct from the environment and does no clever mapping at all. This function should rarely be used.
-
get_session_id
-
Get the current session ID.
-
get_site_default_lang
-
Get the site's default language, with support for URL overrides.
-
get_site_name
-
Get the site name.
-
get_stats_track
-
Get a results table showing info about the member's travels around the site.
-
get_super_admin_groups
-
Get a list of the super admin usergroups.
-
get_table_prefix
-
Get the table prefixes used for all ocPortal tables, commonly used when you are installing ocPortal in the same database as your forums. The default table prefix is 'ocp4_'. Note that anything that might write to an arbitrary db, must ask that db for it's table prefix (if it needs it of course... the db abstracts away most needs for it)
-
get_table_prefix
-
Get the table prefixes used for all ocPortal tables, commonly used when you are installing ocPortal in the same database as your forums. The default table prefix is 'ocp4_'.
-
get_theme
-
Get the current member's theme identifier.
-
get_timezoned_date
-
Get a nice formatted date from the specified Unix timestamp.
-
get_timezoned_time
-
Get a nice formatted time from the specified Unix timestamp.
-
get_translated_tempcode
-
This function is an offshoot of get_translated_text, it instead returns parsed comcode that is linked to the specified language id.
-
get_translated_text
-
Try to return the human-readable version of the language id, passed in as $entry.
-
get_tutorial_link
-
Find a specified tutorial link identifier.
-
get_upload_limit_config_url
-
Get the URL to the config option group for editing limits
-
get_url
-
Get URLs generated according to the specified information. It can also generate a thumbnail if required. It first tries attached upload, then URL, then fails.
-
get_usergroup_list
-
Get a map of forum usergroups (id=>name).
-
get_username
-
Get a member's username.
-
get_use_persistent
-
Find ocPortal was installed to use persistent database connections or not.
-
get_value
-
Find a specified value.
-
get_value_newer_than
-
Find the specified configuration option if it is younger than a specified time.
-
get_version
-
Get the version of ocPortal this addon is for
-
get_webservice_result
-
Lookup error on ocportal.com, to see if there is more information.
-
get_zone_chooser
-
Get a zone chooser interface.
-
get_zone_default_page
-
Get the default page for a zone.
-
get_zone_name
-
Get the name of the zone the current page request is coming from.
-
give_submit_points
-
Give points to a member for submitting something, then returns the XHTML page to say so.
-
globalise
-
Turn the tempcode lump into a standalone page (except for header/footer which is assumed already handled elsewhere).
-
go
-
Run the loader, to load up field-restrictions from the XML file.
-
group
-
Start a group for following messages
-
groupEnd
-
Ends a group you have started before
-
global.php
-
-
global2.php
-
-
google_analytics.php
-
-
$input
-
-
$inputIndex
-
-
$inputLength
-
-
index.php
-
-
index.php
-
-
iframe.php
-
-
incoming_uploads.php
-
-
iframe_script
-
Script to handle iframe.
-
import_from_xml
-
Import to ocPortal database table from the equivalent XML format.
-
improperly_filled_in
-
Complain about a field being missing.
-
improperly_filled_in_post
-
Complain about a POST field being missing.
-
incoming_uploads_script
-
Function to process the file upload process
-
index.php
-
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Log object with label to firebug console
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
info
-
Standard modular info function.
-
inform_exit
-
This is a intended to output an informational exit at the same time as terminating execution
-
inform_screen
-
Get the tempcode for an info page.
-
initialise_filesystem_db
-
Initialise a filesystem DB that we can use for caching.
-
initialise_special_page_types
-
Initialise state variables for the special page type being requested.
-
init__abstract_file_manager
-
Standard code module initialisation function.
-
init__ajax
-
Standard code module initialisation function.
-
init__caches
-
Standard code module initialisation function.
-
init__config
-
Standard code module initialisation function.
-
init__database
-
Standard code module initialisation function.
-
init__database_search
-
Standard code module initialisation function.
-
init__developer_tools
-
Standard code module initialisation function.
-
init__failure
-
Standard code module initialisation function.
-
init__files
-
Standard code module initialisation function.
-
init__files2
-
Standard code module initialisation function.
-
init__forum_stub
-
Standard code module initialisation function.
-
init__global2
-
Standard code module initialisation function.
-
init__lang
-
Standard code module initialisation function.
-
init__lang_compile
-
Standard code module initialisation function.
-
init__lookup
-
Standard code module initialisation function.
-
init__mail
-
Standard code module initialisation function.
-
init__minikernel
-
Standard code module initialisation function.
-
init__m_zip
-
Standard code module initialisation function.
-
init__obfuscate
-
Standard code module initialisation function.
-
init__permissions
-
Standard code module initialisation function.
-
init__site
-
Standard code module initialisation function.
-
init__sitemap
-
Standard code module initialisation function.
-
init__support
-
Standard code module initialisation function.
-
init__symbols
-
Standard code module initialisation function.
-
init__tempcode
-
Standard code module initialisation function.
-
init__tempcode_compiler
-
Standard code module initialisation function.
-
init__tempcode__runtime
-
Standard code module initialisation function.
-
init__templates
-
Standard code module initialisation function.
-
init__temporal
-
Standard code module initialisation function.
-
init__themes
-
Standard code module initialisation function.
-
init__uploads
-
Standard code module initialisation function.
-
init__urls
-
Standard code module initialisation function.
-
init__users
-
Standard code module initialisation function.
-
init__word_filter
-
Standard code module initialisation function.
-
init__zones
-
Standard code module initialisation function.
-
init__zones2
-
Standard code module initialisation function.
-
insert_code_after__by_command
-
Insert some code into a function in the given code snippet, by command (after command).
-
insert_code_after__by_linenum
-
Insert some code into a function in the given code snippet, by line number (after line number).
-
insert_code_before__by_command
-
Insert some code into a function in the given code snippet, by command (before command).
-
insert_code_before__by_linenum
-
Insert some code into a function in the given code snippet, by line number (before line number).
-
insert_lang
-
Insert a language entry into the translation table, and returns the id.
-
insert_lang_comcode
-
Insert a comcode language entry into the translation table, and returns the id.
-
inspect
-
Output whatever arguments are given for debugging. If possible it'll output with plain text, but if output has already started it will attach messages.
-
inspect_plain
-
Output whatever arguments are given for debugging as text and exit. If possible it'll output with plain text, but if output has already started it will attach messages.
-
install
-
Standard modular install function.
-
install
-
Standard modular install function.
-
integer_format
-
Format the given integer number as a nicely formatted string.
-
intelligent_write_error
-
Discern the cause of a file-write error, and show an appropriate error message.
-
intelligent_write_error_inline
-
Discern the cause of a file-write error, and return an appropriate error message.
-
invert_value
-
Very simple function to invert the meaning of an old hidden option. We often use this when we've promoted a hidden option into a new proper option but inverted the meaning in the process - we use this in the default value generation code, as an in-line aid to preserve existing hidden option settings.
-
invisible
-
The actualiser for entering conceded mode.
-
in_memory_search_match
-
Perform a database-style in-memory boolean search on single item.
-
in_safe_mode
-
Find whether we are running in safe mode.
-
ip_banned
-
Check to see if an IP address is banned.
-
isAlphaNum
-
Find whether a character is alphanumeric
-
is_alphanumeric
-
Find whether the specified string is alphanumeric or not.
-
is_browser_decacheing
-
Find whether the browser session is set to be doing a hard cache-empty refresh.
-
is_data_encrypted
-
Determine if some data has already been encrypted: i.e. if it has a magic encryption marker.
-
is_definitely_empty
-
Find whether the current tempcode object is definitely blank, by doing a very quick check.
-
is_empty
-
Find whether the current tempcode object is blank or not.
-
is_encryption_available
-
Determine whether the necessary PHP extensions to support encryption are available. For normal use, you should probably use is_encryption_enabled() instead.
-
is_encryption_enabled
-
Determine whether encryption support is available and enabled in the site's preferences, and the keys are in place.
-
is_guest
-
Find whether the current member is a guest.
-
is_httpauth_login
-
Find whether the current member is logged in via httpauth.
-
is_image
-
Find whether the image specified is actually an image, based on file extension
-
is_mobile
-
Look at the user's browser, and decide if they are viewing on a mobile device or not.
-
is_page_https
-
Find whether the specified page is to use HTTPS (if not -- it will use HTTP).
-
is_really_empty
-
Tests to see if something would evaluate to blank or not
-
is_saveable_image
-
Use the image extension to determine if the specified image is of a format (extension) saveable by ocPortal or not.
-
is_special_file
-
Find whether a file should be ignored.
-
is_staff
-
Find whether a member is staff.
-
is_suexec_like
-
Find whether we can get away with natural file access, not messing with AFMs, world-writability, etc.
-
is_super_admin
-
Find whether a member is a super administrator.
-
is_swf_upload
-
Find whether an swfupload upload has just happened, and optionally simulate as if it were a normal upload (although 'is_uploaded_file'/'move_uploaded_file' would not work).
-
is_valid_email_address
-
Find whether the specified address is a valid e-mail address or not.
-
is_video
-
Find whether the video specified is actually an video, based on file extension
-
is_wide
-
Find whether panels will be shown.
-
is_wide_high
-
Find whether panels and the header/footer areas won't be shown.
-
is_writable_wrap
-
Find whether a file/directory is writeable. This function is designed to get past that the PHP is_writable function does not work properly on Windows.
-
index.php
-
-
images.php
-
-
incoming_uploads.php
-
-
input_filter.php
-
-
inst_special.php
-
-
integrator.php
-
-
$orderer
-
-
$organisation
-
-
$output
-
-
$output_of_action_is_confirmation
-
-
obfuscate_email_address
-
Obfuscate the given e-mail address.
-
obfuscate_entities
-
Obfuscate the given text using HTML entity encoding.
-
object_factory
-
Make an object of the given class
-
ocfilter_to_idlist_using_callback
-
Turn an ocFilter (a filter specifying which records to match) into a list of ID numbers.
-
ocfilter_to_idlist_using_db
-
Turn an ocFilter (a filter specifying which records to match) into a list of ID numbers, relying on the database to extract the record-set.
-
ocfilter_to_idlist_using_memory
-
Turn an ocFilter (a filter specifying which records to match) into a list of ID numbers, using a prebuilt memory representation of the record-set.
-
ocfilter_to_sqlfragment
-
Turn an ocFilter (a filter specifying which records to match) into an SQL query fragment.
-
ocf_require_all_forum_stuff
-
Require all code relating to the OCF forum
-
ocportal_cleanup
-
Rebuild the specified caches.
-
ocportal_error_handler
-
ocPortal error handler (hooked into PHP error system).
-
ocp_admirecookie
-
Get a cookie value.
-
ocp_eatcookie
-
Deletes a cookie (if it exists), from within ocPortal's cookie environment.
-
ocp_mb_strlen
-
Get string length, with utf-8 awareness where possible/required.
-
ocp_mb_strtolower
-
Make a string lowercase, with utf-8 awareness where possible/required.
-
ocp_mb_strtoupper
-
Make a string uppercase, with utf-8 awareness where possible/required.
-
ocp_mb_substr
-
Return part of a string, with utf-8 awareness where possible/required.
-
ocp_setcookie
-
Create a cookie, inside ocPortal's cookie environment.
-
ocp_simple_xml_reader
-
-
ocp_simple_xml_reader
-
Constructs the XML reader: parses the given data. Check $gleamed and $error after constructing.
-
ocp_srv
-
Get server environment variables.
-
ocp_tempcode
-
-
ocp_tempcode
-
Constructor of tempcode
-
ocp_tempnam
-
Create file with unique file name, but works around compatibility issues between servers.
-
ocp_url_decode_post_process
-
Decode a URL component that was encoded with hackerish_url_encode
-
ocp_url_encode
-
Encode a URL component in such a way that it won't get nuked by Apache %2F blocking security and url encoded '&' screwing. The get_param function will map it back. Hackerish but necessary.
-
ocp_url_encode_mini
-
Encode a URL component, as per ocp_url_encode but without slashes being encoded.
-
ocp_version
-
Get the major version of your installation.
-
ocp_version_full
-
Get the full string version of ocPortal that you are running.
-
ocp_version_minor
-
Get the minor/patch version of your installation. This changes with each release, including bug fix releases. It generally consists of 'a' or 'a.b', where 'a' increments represent major changes and 'b' increments represent tiny changes or alpha/beta/RC numbering.
-
ocp_version_number
-
Get the general version number of your installation (incorporates major and minor verson number).
-
ocp_version_time
-
Get the timestamp at which this version was released.
-
ocp_version_time_major
-
Get the timestamp at which this MAJOR version was released.
-
online_link
-
Get a URL to a forum 'user online' list.
-
opensearch_script
-
Server opensearch requests.
-
obfuscate.php
-
-
ocfiltering.php
-
-
override_api.php
-
-
$redirect_type
-
-
read_multi_code
-
Read a multi code from a named parameter stub.
-
read_text_file
-
Read a text file, using the _custom system
-
redirect_screen
-
Redirect the user - transparently, storing a message that will be shown on their destination page.
-
refresh_field_definition
-
If we've changed what $type is stored as, this function will need to be called to change the typing in the DB.
-
reinstall_block
-
Reinstall a block if it has become corrupted for any reason.
-
reinstall_module
-
Reinstall the specified module.
-
relay_error_mail
-
Relay an error message, if appropriate, to e-mail listeners (sometimes ocProducts, and site staff).
-
remove_code
-
Remove some code from a function in the given code snippet.
-
remove_duplicate_rows
-
Remove any duplication inside the list of rows (each row being a map). Duplication is defined by rows with correspinding IDs.
-
remove_ip_ban
-
Remove an IP-ban.
-
remove_magic_encryption_marker
-
Remove the magic encryption marker from some data. This should be used if the data is to be displayed or presented for editing, but not if it's to be put in the database.
-
remove_url_mistakes
-
Map spaces to %20 and put http:// in front of URLs starting www.
-
rename_table
-
Rename the given table.
-
replace_scripts
-
-
reprocess_url
-
Take a URL and process it to make a hard include. We'll get the HTML and we'll also load up some global stuff for 'do_header' to use.
-
request_page
-
Take the specified parameters, and try to find the corresponding page, then execute a function to load the page (load_html_page/load_comcode_page).
-
require_all_lang
-
Include all the language files for use in the script.
-
require_all_open_lang_files
-
Require all the open language files. This doesn't hurt performance.
-
require_code
-
This function is a very important one when coding. It allows you to include a source code file (from root/sources/ or root/sources_custom/) through the proper channels.
-
require_code_no_override
-
Require code, but without looking for sources_custom overrides
-
require_css
-
Make sure that the given CSS file is loaded up.
-
require_javascript
-
Make sure that the given javascript file is loaded up.
-
require_lang
-
Includes a language file for use in the script.
-
require_lang_compile
-
Load up a language file, compiling it (it's not cached yet).
-
restricted_manually_enabled_backdoor
-
Backdoor handler. Can only be activated by those with FTP write-access.
-
restrictify
-
Add ocPortal's strictness, after finishing with third-party code. To be run optionally at some point after destrictify().
-
retrieve_autosave
-
AJAX script to retrieve an autosave.
-
rss
-
-
rss
-
Constructs the RSS reader: downloads the URL and parses it. Check $error after constructing.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function for CRON hooks. Searches for tasks to perform.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function for do_next_menu hooks. They find links to put on standard navigation menus of the system.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function for preview hooks.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
run
-
Standard modular run function.
-
running_script
-
Find whether a certain script is being run to get here.
-
rss.php
-
-
$second_stage_preview
-
-
$select_name_description
-
-
$send_validation_request
-
-
$seo_type
-
-
$seq_parts
-
-
$skip_validation
-
-
$special_edit_frontend
-
-
$static_ob
-
-
sheet.php
-
-
site_tree.php
-
-
sms.php
-
-
snippet.php
-
-
search
-
Actualiser to perform Admin Zone search.
-
send
-
Log object to firebug
-
send_datas
-
-
send_headers
-
-
send_validation_request
-
Send (by e-mail) a validation request for a submitted item to the admin.
-
seo_get_fields
-
Get template fields to insert into a form page, for manipulation of seo fields.
-
seo_meta_erase_storage
-
Erase a seo entry... as these shouldn't be left hanging around once content is deleted.
-
seo_meta_get_for
-
Get meta information for specified resource
-
seo_meta_load_for
-
Load the specified resource's meta information into the system for use on this page.
-
seo_meta_set_for_explicit
-
Explictly sets the meta information for the specified resource.
-
seo_meta_set_for_implicit
-
Sets the meta information for the specified resource, by auto-summarisation from the given parameters.
-
servertime_to_usertime
-
Convert a server timestamp to a user timestamp. The user timestamp should not be pumped through get_timezoned_date as this already performs the conversions internally.
-
set
-
(Plug-in replacement for memcache API) Put data into the persistant cache.
-
set
-
(Plug-in replacement for memcache API) Put data into the persistant cache.
-
set
-
(Plug-in replacement for memcache API) Put data into the persistant cache.
-
set
-
(Plug-in replacement for memcache API) Put data into the persistant cache.
-
set
-
(Plug-in replacement for memcache API) Put data into the persistant cache.
-
setEnabled
-
Enable and disable logging to Firebug
-
setObjectFilter
-
Specify a filter to be used when encoding an object
-
setOptions
-
Set some options for the library
-
set_category_permissions_from_environment
-
Assuming that permission details are POSTed, set the permissions for the specified category, in the current page
-
set_long_value
-
Set the specified situational value to the specified long value.
-
set_option
-
Set a configuration option with the specified values.
-
set_page_permissions_from_environment
-
Assuming that permission details are POSTed, set the permissions for the specified category, in the current page
-
set_permissions
-
Set permissions of the news category from POST parameters.
-
set_session_id
-
Set the session ID of the user.
-
set_specific_permission
-
Sets the specific-permission of a usergroup
-
set_tutorial_link
-
Set the specified value to the specified tutorial link identifier.
-
set_value
-
Set the specified situational value to the specified value.
-
sheet_script
-
AJAX script for dynamic inclusion of CSS.
-
show
-
Get a list of all the e-mails sent/queued.
-
show_memory_points
-
Output whatever memory points we collected up.
-
shuffle_for
-
Shuffle an array into an array of columns.
-
simple_tracker_script
-
Script to track clicks to external sites.
-
simulated_wildcard_match
-
Do a wildcard match by converting to a regular expression.
-
singular_bind
-
Replace the named parameter with a specific value. Hardly used, but still important.
-
sitemaps_build
-
Top level function to (re)generate a Sitemap (xml file, Google-style).
-
sitemaps_xml_finished
-
Finalise the writing to a Sitemaps XML file.
-
sitemaps_xml_initialise
-
Initialise the writing to a Sitemaps XML file. You can only call one of these functions per time as it uses global variables for tracking.
-
site_tree_do_next_manager
-
The do-next manager for after content management.
-
site_tree_script
-
AJAX script for dynamically extended sitetree.
-
skippable_keep
-
Find whether we can skip the normal preservation of a keep value, for whatever reason.
-
sms_callback_script
-
Handle maintenance of SMS numbers (block numbers if they prove unreliable).
-
sms_wrap
-
Attempt to send an SMS.
-
snippet_script
-
AJAX script for dynamic inclusion of XHTML snippets.
-
sort_search_results
-
Sort search results as returned by the search hook.
-
side_personal_stats.php
-
-
sms_api_id.php
-
-
sms_high_limit.php
-
-
sms_high_trigger_limit.php
-
-
sms_low_limit.php
-
-
sms_low_trigger_limit.php
-
-
sms_password.php
-
-
sms_username.php
-
-
sitemap.php
-
-
seo2.php
-
-
shared_installs.php
-
-
site.php
-
-
site2.php
-
-
sitemap.php
-
-
site_adminzone.php
-
-
site_html_pages.php
-
-
site_tree.php
-
-
splurgh.php
-
-
submit.php
-
-
support.php
-
-
support2.php
-
-
symbols.php
-
-
side_facebook_activity.php
-
-
spawn_page_crawl
-
Start up a search for page-links, writing results into the callback. Usually we pass a callback that builds a Sitemap XML file, but we don't need to- it can be anything.
-
special_page_types
-
Handle special page type output.
-
splurgh_master_build
-
Get a splurghified version of the specified item.
-
staff_tips_script
-
Outputs the staff tips iframe.
-
standard_aed_module
-
-
startElement
-
Standard PHP XML parser function.
-
startElement
-
Standard PHP XML parser function.
-
startElement
-
Standard PHP XML parser function.
-
startNameSpace
-
Standard PHP XML parser function.
-
startText
-
Standard PHP XML parser function.
-
startText
-
Standard PHP XML parser function.
-
startText
-
Standard PHP XML parser function.
-
static_evaluate_tempcode
-
Simple function to evaluate some Tempcode. Very rarely to be used, only if you can't call a method (e.g. you are copying direct into an array, such as in block cacheing).
-
store_autosave
-
AJAX script to store an autosave.
-
strlen_sort
-
Helper function for usort to sort a list by string length.
-
suggest_fatalistic
-
Give the user an option to see a stack trace by adding in a link, but only if they have permission
-
suggest_new_idmoniker_for
-
Called when content is added, based upon a new form field that specifies what moniker to use.
-
su_login
-
Filter a member ID through SU, if SU is on and if the user has permission.
-
symbol_tempcode
-
This will create a new tempcode object that is containing a single specifed symbol
-
symbol_truncator
-
Handle truncation symbols in all their complexity
-
sync_file
-
Provides a hook for file synchronisation between mirrored servers. Called after any file creation, deletion or edit.
-
sync_file_move
-
Provides a hook for file-move synchronisation between mirrored servers. Called after any rename or move action.
-
$table
-
-
$table_exists_cache
-
-
$table_prefix
-
-
$table_prefix
-
-
$tag_stack
-
-
$tag_stack
-
-
$tag_stack
-
-
$text_lookup_cache
-
-
$text_lookup_original_cache
-
-
$text_so_far
-
-
$text_so_far
-
-
$text_stack
-
-
$this_page
-
-
$this_type
-
-
$title_is_multi_lang
-
-
$type
-
-
$type_code
-
-
tar.php
-
-
tempcode.php
-
-
tempcode_compiler.php
-
-
tempcode_compiler__runtime.php
-
-
tempcode__runtime.php
-
-
templates.php
-
-
temporal.php
-
-
temporal2.php
-
-
textfiles.php
-
-
themes.php
-
-
type_validation.php
-
-
table
-
Log a table in the firebug console
-
table_exists
-
Check if a table exists.
-
tar_add_file
-
Add a file to the specified TAR file.
-
tar_add_folder
-
Add a folder to the TAR archive
-
tar_add_folder_incremental
-
Add a folder to the TAR archive, however only store files modifed after a threshold time. It is incremental (incremental backup), by comparing against a threshold before adding a file (threshold being time of last backup)
-
tar_close
-
Close an open TAR resource.
-
tar_crc
-
Find the checksum specified in a TAR header
-
tar_extract_to_folder
-
Extract all the files in the specified TAR file to the specified path.
-
tar_get_directory
-
Return the root directory from the specified TAR file. Note that there are folders in here, and they will end '/'.
-
tar_get_file
-
Get the contents of the specified file in the specified TAR.
-
tar_open
-
Open up a TAR archive, and return the resource.
-
template_to_tempcode
-
Convert template text into tempcode format.
-
thumb_script
-
Allows conversion of a URL to a thumbnail via a simple script.
-
tick_func
-
Profile tick function.
-
to_assembly
-
Assemble the current tempcode object into a single serialised (compiled) tempcode storage representation (parameters and certain symbols and not evaluated). The output of the function is language-tied.
-
tpl_previews
-
Get mapping between template names and the method of this class that can render a preview of them
-
tpl_preview__administrative__action_logs_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__administrative__action_logs_toggle_link
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__administrative__broken_lang_strings
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__administrative__broken_urls
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__administrative__fatal_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__administrative__lookup_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__administrative__query_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__administrative__stack_trace_hyper_wrap
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__administrative__tempcode_test
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__block_main_comcode_page_children
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__block_main_emoticon_codes
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__block_main_sitemap
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__block_no_entries
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__block_side_personal_stats
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__block_side_personal_stats_no
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__block_side_zone_jump
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__css_need
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__css_need_inline
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__email_log_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__forums_embed
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__forum_attachment_image
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__forum_attachment_link
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__inline_wip_message
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__ipban_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__javascript_need
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__javascript_need_inline
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__java_detect
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__login_failed_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__login_redirect_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__login_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__missing_screen
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__param_info
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__quick_js_loader
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
tpl_preview__zone_choose
-
Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
-
trace
-
Log a trace in the firebug console
-
trueStartText
-
Parse the complete text of the inside of the tag.