[core] element index

Package indexes

All elements
a b c d e f g h i j k l m n o p q r s t u v w x z _
_
top
_access_denied
_access_denied() in failure.php
Show a helpful access-denied page. Has a login ability if it senses that logging in could curtail the error.
_access_string
_access_string() in abstract_file_manager.php
Convert an integer permission to the string version.
_ad
standard_aed_module::_ad() in aed_module.php
Standard modular UI/actualiser to add an entry.
_box_callback
_box_callback() in mail.php
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_url() in urls.php
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_sizes() in database_helper.php
Check a set of fields aren't going to exceed key limits.
_choose_moniker
_choose_moniker() in urls2.php
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
_css_compile() in css_and_js.php
Return a specific compiled CSS file.
_css_ocp_include
_css_ocp_include() in css_and_js.php
preg_replace callback, to handle CSS file inclusion.
_deldir_contents
_deldir_contents() in files2.php
Delete all the contents of a directory, and any subdirectories of that specified directory (recursively).
_diff_simple
_diff_simple() in diff.php
_do_lang
_do_lang() in lang.php
Get the human-readable form of a language id, or a language entry from a language INI file.
_do_template
_do_template() in tempcode_compiler.php
A template has not been structurally cached, so compile it and store in the cache.
_ed
standard_aed_module::_ed() in aed_module.php
Standard modular UI to edit an entry.
_edit
Module_admin_emaillog::_edit() in admin_emaillog.php
Actualiser to edit/send/delete an email.
_enforce_sessioned_url
_enforce_sessioned_url() in users_inactive_occasionals.php
Make sure that the given URL contains a session if cookies are disabled.
_export_table_to_xml
_export_table_to_xml() in xml_storage.php
Export an ocPortal database table to an equivalent XML format.
_fatal_exit
_fatal_exit() in failure.php
Do a fatal exit, echo the header (if possible) and an error message, followed by a debugging back-trace.
_find_all_langs
_find_all_langs() in lang3.php
Get an array of all the installed languages that can be found in root/lang/ and root/lang_custom/
_find_all_modules
_find_all_modules() in zones2.php
Get an array of all the modules.
_find_all_pages
_find_all_pages() in zones2.php
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
_find_text_file_path() in textfiles.php
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
_ftp_info() in abstract_file_manager.php
Return the FTP connection, from stored/posted details.
_general_db_init
_general_db_init() in database.php
Called once our DB connection becomes active.
_generic_exit
_generic_exit() in failure.php
Do a terminal execution on a defined page type
_get_block_path
_get_block_path() in zones.php
Gets the path to a block code file for a block code name
_get_dir_tree
_get_dir_tree() in abstract_file_manager.php
Get a list of files under a directory.
_get_input_date
_get_input_date() in temporal2.php
Check a POST inputted date for validity, and get the Unix timestamp for the inputted date.
_get_lang_file_map
_get_lang_file_map() in lang_compile.php
Extend a language map from strings in a given language file.
_get_module_path
_get_module_path() in zones.php
Get the path to a module known to be in a certain zone.
_get_specify_url
_get_specify_url() in uploads.php
Filters specified URLs to make sure we're really allowed to access them.
_get_upload_url
_get_upload_url() in uploads.php
Converts an uploaded file into a URL, by moving it to an appropriate place.
_get_where_clause_groups
_get_where_clause_groups() in permissions.php
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
_helper_add_table_field() in database_helper.php
Adds a field to an existing table.
_helper_alter_table_field
_helper_alter_table_field() in database_helper.php
Change the type of a DB field in a table. Note: this function does not support ascession/decession of translatability
_helper_change_primary_key
_helper_change_primary_key() in database_helper.php
Change the primary key of a table.
_helper_create_index
_helper_create_index() in database_helper.php
Add an index to a table without disturbing the contents, after the table has been created.
_helper_create_table
_helper_create_table() in database_helper.php
Create a table with the given name and the given array of field name to type mappings.
_helper_delete_index_if_exists
_helper_delete_index_if_exists() in database_helper.php
Delete an index from a table.
_helper_delete_table_field
_helper_delete_table_field() in database_helper.php
Delete the specified field from the specified table.
_helper_drop_if_exists
_helper_drop_if_exists() in database_helper.php
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
_helper_refresh_field_definition() in database_helper.php
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
_helper_rename_table() in database_helper.php
Rename the given table.
_http_download_file
_http_download_file() in files2.php
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_callback() in mail.php
Indent text lines. Callback for preg_replace_callback.
_insert_lang
_insert_lang() in lang3.php
Insert a language entry into the translation table, and returns the id.
_inspect
_inspect() in developer_tools.php
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
_lang_remap() in lang3.php
Remap the specified language id, and return the id again - the id isn't changed.
_length_so_far
_length_so_far() in tempcode_compiler.php
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_it() in support2.php
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
_nice_get_langs() in lang3.php
Get a nice formatted XHTML listed language selector.
_ocfilter_eq
_ocfilter_eq() in ocfiltering.php
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
_ocfilter_neq() in ocfiltering.php
Helper function to generate an SQL "not equal to" fragment.
_ocfilter_subtree_fetch
_ocfilter_subtree_fetch() in ocfiltering.php
Helper function to fetch a subtree from the database.
_ocfilter_to_generic
_ocfilter_to_generic() in ocfiltering.php
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
_param_invalid() in failure.php
Handle invalid parameter values.
_qualify_url
_qualify_url() in urls2.php
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
_request_page() in site.php
Take the specified parameters, and try to find the corresponding page
_rescope_path
_rescope_path() in abstract_file_manager.php
Rescope an ocPortal path to a path suitable for the AFM connection.
_search_img_file
_search_img_file() in themes.php
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
_splurgh_do_node() in splurgh.php
Build up the splurgh nodes recursively for given details.
_strip_junk_words
Strip junk words from the keywords representing a search.
_sync_file_move
_sync_file_move() in files2.php
Provides a hook for file-move synchronisation between mirrored servers. Called after any rename or move action.
_synonyms
Get synonyms for ocPortal terminology.
_tab
_tab() in xml_storage.php
Add one layer of tabbing to some XML.
_title_callback
_title_callback() in mail.php
Make titles readable. Callback for preg_replace_callback.
_translate_dir_access
_translate_dir_access() in abstract_file_manager.php
Translate truth about needing world write access to a directory to absolute permissions.
_translate_file_access
_translate_file_access() in abstract_file_manager.php
Translate truth about needing world write access to a file to absolute permissions.
_urlise_lang
_urlise_lang() in lang_urlise.php
URL'ise specially encoded text-acceptance language strings.
_url_rewrite_params
Attempt to use mod_rewrite to improve this URL.
_url_to_filename
_url_to_filename() in urls2.php
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
_url_to_pagelink() in urls2.php
Convert a local URL to a page-link.
_xml_rpc_type_convert
Convert some data to XML-RPC format.
__construct
Compressor::__construct() in edit_area_compressor.php
__ed
standard_aed_module::__ed() in aed_module.php
Standard modular UI/actualiser to edit an entry.
__param
__param() in global2.php
Helper function to load up a GET/POST parameter.
__sleep
ocp_tempcode::__sleep() in tempcode.php
PHP magic function to handle serialisation.
a
top
$a
JSMin::$a in css_and_js.php
$add_one_cat_label
$add_one_label
$add_submit_name
$add_text
$alt_aed_module
$appended_actions_already
$archive_entry_point
$archive_label
$array_key
$attribute_stack
$attribute_stack
$attribute_stack
$author
$award_type
access_denied
access_denied() in permissions.php
Show a helpful access-denied page. Has a login ability if it senses that logging in could curtail the error.
action
JSMin::action() in css_and_js.php
Handle internal parse situation
actual_add_zone
actual_add_zone() in zones2.php
Add a zone.
actual_delete_zone
actual_delete_zone() in zones3.php
Delete a zone.
actual_delete_zone_lite
Delete a zones database stuff.
actual_edit_zone
actual_edit_zone() in zones3.php
Edit a zone.
actual_rename_zone_lite
Rename a zone in the database.
ad
standard_aed_module::ad() in aed_module.php
Standard modular UI to add an entry.
addon_installed
addon_installed() in support.php
Check to see if an addon is installed.
add_config_option
add_config_option() in database_action.php
Add a configuration option into the database, and initialise it with a specified value.
add_ip_ban
add_ip_ban() in failure.php
Add an IP-ban.
add_specific_permission
add_specific_permission() in database_action.php
Add a specific-permission, and apply it to every usergroup.
add_table_field
Adds a field to an existing table.
admin.php
admin.php in admin.php
admin_emaillog.php
admin_emaillog.php in admin_emaillog.php
admin_lookup.php
admin_lookup.php in admin_lookup.php
admin_version.php
admin_version.php in admin_version.php
adminzone_extend_breadcrumbs
adminzone_extend_breadcrumbs() in site_adminzone.php
Extend breadcrumbs for the Admin Zone (called by breadcrumbs_get_default_stub).
adminzone_special_cases
adminzone_special_cases() in site_adminzone.php
Special code to render Admin Zone Comcode pages with special significances.
afm_copy
afm_copy() in abstract_file_manager.php
Copies a file (NOT a directory) on the open AFM connection.
afm_delete_directory
afm_delete_directory() in abstract_file_manager.php
Delete a directory over the open AFM connection.
afm_delete_file
afm_delete_file() in abstract_file_manager.php
Deletes a file (NOT a directory) on the open AFM connection.
afm_make_directory
afm_make_directory() in abstract_file_manager.php
Make a directory over the open AFM connection.
afm_make_file
afm_make_file() in abstract_file_manager.php
Make a new file over the open AFM connection. Will overwrite if already exists (assuming has access).
afm_move
afm_move() in abstract_file_manager.php
Moves a file on the open AFM connection.
afm_read_file
afm_read_file() in abstract_file_manager.php
Read a file (not actually over the open AFM connection, but same result: we can do this directly).
afm_set_perms
afm_set_perms() in abstract_file_manager.php
Sets permissions over the open AFM connection.
ajax_tree_script
ajax_tree_script() in ajax.php
AJAX script for dynamically extended selection tree.
alter_table_field
Change the type of a DB field in a table. Note: this function does not support ascession/decession of translatability
amicrotime_diff
amicrotime_diff() in index.php
Get the time difference in microseconds between two PHP microtimes.
apccache
apccache in caches_apc.php
applies
Find whether this preview hook applies.
apply_tempcode_escaping
Apply whatever escaping is requested to the given value.
apply_tempcode_escaping_inline
Apply whatever escaping is requested to the given value.
array_peek
array_peek() in support.php
Peek at a stack element.
assign_refresh
assign_refresh() in site2.php
Assign a page refresh to the specified URL.
attach
ocp_tempcode::attach() in tempcode.php
Attach the specified tempcode to the right of the current tempcode object.
attach_message
attach_message() in site.php
Attach a message to the page output.
autogenerate_new_url_moniker
Called from 'find_id_moniker'. We tried to lookup a moniker, found a hook, but found no stored moniker. So we'll try and autogenerate one.
ajax_tree.php
ajax_tree.php in ajax_tree.php
autosave.php
autosave.php in autosave.php
abstract_file_manager.php
abstract_file_manager.php in abstract_file_manager.php
aed_module.php
aed_module.php in aed_module.php
ajax.php
ajax.php in ajax.php
autosave.php
autosave.php in autosave.php
advanced_admin_cache.php
advanced_admin_cache.php in advanced_admin_cache.php
b
top
$b
JSMin::$b in css_and_js.php
ban_ip
ban_ip() in submit.php
Ban the specified IP address.
better_parse_ini_file
Parse the specified INI file, and get an array of what it found.
bind
ocp_tempcode::bind() in tempcode.php
Bind the parameter bits, or recursively bind children (doesn't change self, returns a bound tempcode object)
block_helper_script
block_helper_script() in misc_scripts.php
Shows an HTML page for making block Comcode.
block_installed
block_installed() in zones.php
Check to see if a block is installed.
Block_main_as_zone_access
Block_main_as_zone_access in main_as_zone_access.php
Block_main_comcode_page_children
Block_main_comcode_page_children in main_comcode_page_children.php
Block_main_db_notes
Block_main_db_notes in main_db_notes.php
Block_main_facebook_comments
Block_main_facebook_comments in main_facebook_comments.php
Block_main_facebook_facepile
Block_main_facebook_facepile in main_facebook_facepile.php
Block_main_facebook_like
Block_main_facebook_like in main_facebook_like.php
Block_main_greeting
Block_main_greeting in main_greeting.php
Block_main_include_module
Block_main_include_module in main_include_module.php
Block_main_notes
Block_main_notes in main_notes.php
Block_main_only_if_match
Block_main_only_if_match in main_only_if_match.php
Block_main_sitemap
Block_main_sitemap in main_sitemap.php
block_main_sitemap__cache_on
block_main_sitemap__cache_on() in main_sitemap.php
Find the cache signature for the block.
Block_side_facebook_activity
Block_side_facebook_activity in side_facebook_activity.php
Block_side_personal_stats
Block_side_personal_stats in side_personal_stats.php
brand_base_url
brand_base_url() in support.php
Find the base URL for documentation.
breadcrumbs
breadcrumbs() in site.php
Get the tempcode for the breadcrumbs.
breadcrumbs_get_default_stub
Get the tempcode for the default breadcrumbs stub. This isn't entirely a default, because it does work with breadcrumb_set_parents. We refer to it as a default as it is possible to override the whole breadcrumbs environment via the special BREADCRUMBS global variable.
breadcrumb_add_segment
Add a segment to the breadcrumbs (if this isn't used, a default will be used for the stub).
breadcrumb_set_parents
Put a list of parents in for the breadcrumbs.
breadcrumb_set_self
Set the current title.
browser_matches
browser_matches() in support.php
See's if the current browser matches some special property code. Assumes users are keeping up on newish browsers (except for IE users, who are 6+)
build_closure_function
build_closure_function() in tempcode_compiler.php
Build a closure function for a compiled template.
build_closure_tempcode
build_closure_tempcode() in tempcode.php
Build a conventional tempcode object
build_content_where
build_content_where() in database_search.php
Build a fulltext query WHERE clause from given content.
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_search_results_interface
build_search_results_interface() in database_search.php
Build a templated list of the given search results, for viewing.
build_search_submitter_clauses
build_search_submitter_clauses() in database_search.php
Build up a submitter search clause, taking into account members, authors, usernames, and usergroups.
build_url
build_url() in urls.php
Build and return a proper URL, from the $vars array.
block_comcode.php
block_comcode.php in block_comcode.php
c
top
$cached_output
$care_please
$catalogue
$cat_aed_module
$check_validation
$children_stack
$codename
ocp_tempcode::$codename in tempcode.php
$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
can_arbitrary_groupby() in database.php
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
catch_fatal_errors() in global2.php
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
cdn_filter() in themes.php
Filter a path so it runs through a CDN.
ce_do_footer
ce_do_footer() in config_editor.php
Output the config editors page footer.
ce_do_header
ce_do_header() in config_editor.php
Output the config editors page header.
ce_do_login
ce_do_login() in config_editor.php
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
Compressor::check_cache() in edit_area_compressor.php
check_delete_permission
check_delete_permission() in permissions.php
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_edit_permission() in permissions.php
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_extension() in files2.php
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
Compressor::check_gzip_use() in edit_area_compressor.php
check_memory_limit_for
Check we can load the given file, given our memory limit.
check_posted_field
check_posted_field() in input_filter.php
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_some_edit_permission() in permissions.php
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
check_specific_permission() in permissions.php
Require presence of a permission for the current member; otherwise exit.
check_submit_permission
check_submit_permission() in permissions.php
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_word_filter() in minikernel.php
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
choose_language() in lang.php
UI to choose a language.
cleanup_block_name
cleanup_block_name() in zones2.php
Make a block codename look nice
cleanup_date
cleanup_date() in rss.php
Convert an ISO date into a timestamp.
clean_file_size
clean_file_size() in files.php
Format the specified filesize.
clean_html_title
clean_html_title() in site2.php
Turn an HTML title, which could be complex with images, into a nice simple string we can use in <title> and ;.
clear_ocp_autosave
clear_ocp_autosave() in autosave.php
Declare that an action succeeded - delete safety autosave cookies.
clear_old_uploads
clear_old_uploads() in incoming_uploads.php
Function to clear old uploads, that are older then 2 days
closed_site
closed_site() in site2.php
Render the site as closed.
closure_eval
closure_eval() in tempcode.php
Evaluate some PHP code to put the result into an expression (code is allowed to have side effects).
closure_loop
closure_loop() in tempcode.php
Perform a simple loop, that can be inlined in an expression.
closure_while_loop
closure_while_loop() in tempcode.php
Perform a simple loop, that can be inlined in an expression.
cms.php
cms.php in 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_ip_address() in support.php
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_template() in tempcode_compiler.php
Compile a template into a list of appendable outputs, for the closure-style Tempcode implementation.
compressor
Compressor::compressor() in edit_area_compressor.php
Compressor
Compressor in edit_area_compressor.php
**** <external entry point>
compress_javascript
Compressor::compress_javascript() in edit_area_compressor.php
concede
The actualiser for entering conceded mode.
config_editor.php
config_editor.php in config_editor.php
config_option_exists
config_option_exists() in database_action.php
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
convert_image() in images.php
Resize an image to the specified size, but retain the aspect ratio.
convert_to_internal_encoding
convert_to_internal_encoding() in character_sets.php
Convert some data from one encoding to the internal encoding.
convert_url_to_path
Convert a URL to a local file path.
cookie_login
cookie_login() in users_inactive_occasionals.php
Do a cookie login.
co_sync_file
co_sync_file() in config_editor.php
Provides a hook for file synchronisation between mirrored servers.
co_sync_file_move
co_sync_file_move() in config_editor.php
Provides a hook for file synchronisation between mirrored servers.
crc32_file
crc32_file() in zip.php
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
create_session() in users_inactive_occasionals.php
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
critical_error() in critical_errors.php
Exit with a nicely formatted critical error.
cron_bridge_script
cron_bridge_script() in misc_scripts.php
Script to perform ocPortal CRON jobs called by the real CRON.
cron_installed
cron_installed() in support.php
Find if Cron is installed
css_compile
css_compile() in css_and_js.php
Compile a CSS file.
css_enforce
css_enforce() in global2.php
Force a CSS file to be cached.
css_inherit
css_inherit() in css_and_js.php
Inerit from a CSS file to create a string for a (possibly theme-gen) modified version of that file.
css_minify
css_minify() in css_and_js.php
Minifies stylesheet definitions
css_tempcode
css_tempcode() in global2.php
Get tempcode to tie in (to the HTML, in <head>) all the CSS files that have been required.
current_share_user
current_share_user() in shared_installs.php
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
confirm_session.php in confirm_session.php
cron_bridge.php
cron_bridge.php in cron_bridge.php
caches.php
caches.php in caches.php
caches2.php
caches2.php in caches2.php
caches_apc.php
caches_apc.php in caches_apc.php
caches_eaccelerator.php
caches_eaccelerator.php in caches_eaccelerator.php
caches_filesystem.php
caches_filesystem.php in caches_filesystem.php
caches_wincache.php
caches_wincache.php in caches_wincache.php
caches_xcache.php
caches_xcache.php in caches_xcache.php
character_sets.php
character_sets.php in character_sets.php
config.php
config.php in config.php
config2.php
config2.php in config2.php
critical_errors.php
critical_errors.php in critical_errors.php
css_and_js.php
css_and_js.php in css_and_js.php
core.php
core.php in core.php
check_broken_urls.php
check_broken_urls.php in check_broken_urls.php
collapse_user_zones.php
collapse_user_zones.php in collapse_user_zones.php
core.php
core.php in core.php
d
top
$default_type
$do_next_description
$do_next_editing_categories
$do_preview
database_driver
database_driver in database.php
database_driver
Construct a database driver from connection parameters.
db_encode_like
db_encode_like() in database.php
Encode a LIKE string comparision fragement for the database system. The pattern is a mixture of characters and ? and % wilcard symbols.
db_escape_string
db_escape_string() in database.php
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
db_full_text_assemble() in database.php
Assemble part of a WHERE clause for doing full-text search
db_get_first_id
db_get_first_id() in database.php
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
db_has_full_text() in database.php
Find whether full-text-search is present
db_has_subqueries
db_has_subqueries() in database.php
Find whether subquery support is present
db_like_assemble
db_like_assemble() in database_search.php
Generate SQL for a boolean search.
db_string_equal_to
db_string_equal_to() in database.php
Encode an SQL statement fragment for a conditional to see if two strings are equal.
db_string_not_equal_to
db_string_not_equal_to() in database.php
Encode an SQL statement fragment for a conditional to see if two strings are not equal.
decache
decache() in caches.php
Remove an item from the general cache (most commonly used for blocks).
decache
ocp_tempcode::decache() in tempcode.php
Decache the object.
decrypt_data
decrypt_data() in encryption.php
Decrypt data using asymmetric encryption, and the site's private key (as unlocked by the given passphrase).
deldir_contents
deldir_contents() in files.php
Delete all the contents of a directory, and any subdirectories of that specified directory (recursively).
delete
eacceleratorcache::delete() in caches_eaccelerator.php
(Plug-in replacement for memcache API) Delete data from the persistant cache.
delete
apccache::delete() in caches_apc.php
(Plug-in replacement for memcache API) Delete data from the persistant cache.
delete
wincache::delete() in caches_wincache.php
(Plug-in replacement for memcache API) Delete data from the persistant cache.
delete
filecache::delete() in caches_filesystem.php
(Plug-in replacement for memcache API) Delete data from the persistant cache.
delete
xcache::delete() in caches_xcache.php
(Plug-in replacement for memcache API) Delete data from the persistant cache.
delete_attachments
delete_attachments() in database_action.php
Delete attachments solely used by the specified hook.
delete_config_option
delete_config_option() in database_action.php
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_lang() in lang.php
Delete the specified language entry from the translation table.
delete_specific_permission
delete_specific_permission() in database_action.php
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_upload() in files2.php
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_value() in config.php
Delete a situational value.
deshout_callback
deshout_callback() in input_filter.php
preg_replace callback to de-shout text.
destrictify
destrictify() in developer_tools.php
Remove ocPortal's strictness, to help integration of third-party code.
die_html_trace
die_html_trace() in failure.php
Echo an error message, and a debug back-trace of the current execution stack. Use this for debugging purposes.
diff_compute_new
diff_compute_new() in diff.php
diff_simple
diff_simple() in diff.php
diff_simple_2
diff_simple_2() in diff.php
directive_tempcode
directive_tempcode() in tempcode.php
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_time_period() in temporal.php
Display a time period in a tidy human-readable way.
display_validation_results
Show results of running a validation function.
div
div() in templates.php
Get the tempcode for a div. Similar to paragraph, but may contain more formatting (such as
's)
does_lang_exist
does_lang_exist() in lang.php
Find whether the specified language exists.
do_access
do_access() in config_editor.php
Output the editing page.
do_block
do_block() in zones.php
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_environment_utf8_conversion() in character_sets.php
Do a UTF8 conversion on the environmental GET/POST parameters.
do_footer
do_footer() in site.php
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
do_header() in site.php
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
do_image_thumb() in images.php
Get the tempcode for an image thumbnail.
do_lang_tempcode
do_lang_tempcode() in tempcode.php
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_set() in config_editor.php
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
do_site() in site.php
This is it - the start of rendering of a website page.
do_template
do_template() in tempcode.php
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
do_xhtml_validation() in view_modes.php
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
FB::dump() in firephp.php
Dumps key and variable to firebug server panel
database.php
database.php in database.php
database_action.php
database_action.php in database_action.php
database_helper.php
database_helper.php in database_helper.php
database_search.php
database_search.php in database_search.php
developer_tools.php
developer_tools.php in developer_tools.php
diff.php
diff.php in diff.php
e
top
$edit_one_cat_label
$edit_one_label
$edit_submit_name
$edit_text
$edit_this_cat_label
$edit_this_label
$error
$error
rss::$error in rss.php
$extra_donext_categories
$extra_donext_entries
$extra_donext_whatever
$extra_donext_whatever_title
edit_area_compressor.php
edit_area_compressor.php in edit_area_compressor.php
eacceleratorcache
eacceleratorcache in caches_eaccelerator.php
ed
standard_aed_module::ed() in aed_module.php
Standard modular UI to choose an entry to edit.
edit
Module_admin_emaillog::edit() in admin_emaillog.php
Get a form to edit/send/delete an email.
edit_ping_script
edit_ping_script() in ajax.php
AJAX script for recording that something is currently being edited.
either_param
either_param() in global2.php
Get a value (either POST [u]or[/u] GET), or the default if neither can be found.
either_param_integer
either_param_integer() in global2.php
This function is the integeric partner of either_param, as it returns the value as an integer.
emoticons_script
emoticons_script() in misc_scripts.php
Shows an HTML page of all emoticons clickably.
encrypt_data
encrypt_data() in encryption.php
Encrypt some data using asymmetric encryption and the site's public key. This will return the original data if encryption is disabled. It will add a magic marker to the start of the returned string to show it's been encrypted.
endElement
Standard PHP XML parser function.
endElement
Standard PHP XML parser function.
endElement
Standard PHP XML parser function.
endNameSpace
Standard PHP XML parser function.
enforce_personal_access
enforce_personal_access() in permissions.php
Only allow members here that are either the give member, admins, or have a specific-permission. All other members come up to an error message wall.
enforce_sessioned_url
Make sure that the given URL contains a session if cookies are disabled.
ensure_thumbnail
ensure_thumbnail() in images.php
Take some image/thumbnail info, and if needed make and caches a thumbnail, and return a thumb url whatever the situation.
entity_utf8_decode
entity_utf8_decode() in character_sets.php
Convert some data from UTF to a character set PHP supports, using HTML entities where there's no direct match.
erase_cached_language
erase_cached_language() in view_modes.php
Erase the language cache.
erase_cached_templates
erase_cached_templates() in view_modes.php
Erase all template caches (caches in all themes).
erase_comcode_page_cache
Erase the comcode page cache
erase_tempcode_cache
erase_tempcode_cache() in view_modes.php
Erase the tempcode cache.
error
FB::error() in firephp.php
Log object with label to firebug console
escape_html
escape_html() in support.php
Get the specified string, but with all characters escaped.
evaluate
ocp_tempcode::evaluate() in tempcode.php
Parses the current tempcode object, then return the parsed string
evaluate_conventional_variable
Evaluate a conventional tempcode variable, handling escaping
evaluate_echo
Parse the current tempcode object, then echo it to the browser.
exact_match_sql
exact_match_sql() in database_search.php
Get special SQL from POSTed parameters for a catalogue search field that is to be exact-matched.
export_to_xml
export_to_xml() in xml_storage.php
Export ocPortal database tables to an equivalent XML format, automatically.
extract_html_body
extract_html_body() in xhtml.php
Turn a full HTML document into an HTML fragment.
extract_module_functions
Extract code to execute the requested functions with the requested parameters from the module at the given path.
extract_module_functions_page
Extract code to execute the requested functions with the requested parameters from the module requested.
extract_module_info
extract_module_info() in zones2.php
Extract the info function from a module at a given path.
extract_plain_links
Used to turn plain-text links into real links.
encryption.php
encryption.php in encryption.php
f
top
$feed_url
rss::$feed_url in rss.php
$field_qualification_stack
find_permissions.php
find_permissions.php in find_permissions.php
force_sitemap_generation.php
force_sitemap_generation.php in force_sitemap_generation.php
fallback_lang
fallback_lang() in lang.php
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
fast_uniqid() in tempcode.php
The PHP uniqid function is slow on some PHP versions. This version is much faster.
fatal_exit
fatal_exit() in global2.php
Do a fatal exit, echo the header (if possible) and an error message, followed by a debugging back-trace.
FB
FB in firephp.php
fb
fb() in firephp.php
Sends the given data to the FirePHP Firefox Extension.
field_restriction_loader
field_restriction_loader in input_filter.php
filecache
filecache in caches_filesystem.php
FILE_BINARY
FILE_BINARY in global.php
file_get_contents
file_get_contents() in global.php
Get the contents of a file.
file_get_contents
Compressor::file_get_contents() in edit_area_compressor.php
file_put_contents
Compressor::file_put_contents() in edit_area_compressor.php
file_size_to_tar_block_size
Return the output from the conversion between filesize and TAR block size.
FILE_TEXT
FILE_TEXT in global.php
filter_css
filter_css() in mail.php
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_form_field_default() in input_filter.php
Filter to alter form field values based on fields.xml. Usually a no-op.
filter_naughty
filter_naughty() in global.php
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
find_all_blocks() in zones2.php
Get an array of all the blocks that are currently installed.
find_all_hooks
find_all_hooks() in zones.php
Get an array of all the hook implementations for a hook class.
find_all_langs
find_all_langs() in lang.php
Get an array of all the installed languages that can be found in root/lang/ and root/lang_custom/
find_all_modules
find_all_modules() in zones.php
Get an array of all the modules.
find_all_pages
find_all_pages() in zones.php
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_all_xml_tables() in xml_storage.php
Find a list of all the tables that can be imported/exported as XML.
find_all_zones
find_all_zones() in zones.php
Find the installed zones, up to the first 50 installed
find_cache_on
find_cache_on() in caches.php
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_id_moniker() in urls.php
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
find_lost_option() in config2.php
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_script() in global2.php
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
find_template_path() in view_modes.php
Finds the path of the given template codename.
find_template_place
find_template_place() in support.php
Search for a template.
find_template_tree_nice
find_template_tree_nice() in view_modes.php
Convert a template tree structure into a HTML representation.
find_theme_image
find_theme_image() in themes.php
Find the URL to the theme image of the specified ID. It searches various priorities, including language and theme overrides.
FirePHP_DUMP
FirePHP_DUMP in firephp.php
Dumps a variable to firebug's server panel
FirePHP_ERROR
FirePHP_ERROR in firephp.php
Firebug ERROR level
FirePHP_GROUP_END
FirePHP_GROUP_END in firephp.php
Ends a group in firebug console
FirePHP_GROUP_START
FirePHP_GROUP_START in firephp.php
Starts a group in firebug console
FirePHP_INFO
FirePHP_INFO in firephp.php
Firebug INFO level
FirePHP_LOG
FirePHP_LOG in firephp.php
Firebug LOG level
FirePHP_TABLE
FirePHP_TABLE in firephp.php
Displays a table in firebug console
FirePHP_TRACE
FirePHP_TRACE in firephp.php
Displays a stack trace in firebug console
FirePHP_VERSION
FirePHP_VERSION in firephp.php
FirePHP version
FirePHP_WARN
FirePHP_WARN in firephp.php
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
fix_permissions() in files.php
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
float_format() in support.php
Format the given float number as a nicely formatted string.
float_to_raw_string
float_to_raw_string() in support.php
Convert a float to a "technical string representation of a float".
flush
xcache::flush() in caches_xcache.php
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
flush
wincache::flush() in caches_wincache.php
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
flush
filecache::flush() in caches_filesystem.php
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
flush
apccache::flush() in caches_apc.php
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
flush
eacceleratorcache::flush() in caches_eaccelerator.php
(Plug-in replacement for memcache API) Remove all data from the persistant cache.
force_have_afm_details
force_have_afm_details() in abstract_file_manager.php
Make sure that the AFM connection details have been posted. If not, get them and loop back.
force_httpauth
force_httpauth() in users_inactive_occasionals.php
Force an HTTP authentication login box / relay it as if it were a posted login. This function is rarely used.
form_input_hidden
form_input_hidden() in templates.php
Get the tempcode for a hidden form element.
form_input_list_entry
form_input_list_entry() in templates.php
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
form_to_email() in mail.php
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_driver_base in forum_stub.php
forum_link
Get a URL to a forum.
fractional_edit
fractional_edit() in support.php
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
forums.php in forums.php
failure.php
failure.php in failure.php
files.php
files.php in files.php
files2.php
files2.php in files2.php
firephp.php
firephp.php in firephp.php
forum_stub.php
forum_stub.php in forum_stub.php
filesystem_caching.php
filesystem_caching.php in filesystem_caching.php
forums.php
forums.php in forums.php
g
top
$gleamed
$gleamed_feed
$gleamed_items
geolocate_ip
geolocate_ip() in support.php
Find the country an IP address long is located in
get
apccache::get() in caches_apc.php
(Plug-in replacement for memcache API) Get data from the persistant cache.
get
eacceleratorcache::get() in caches_eaccelerator.php
(Plug-in replacement for memcache API) Get data from the persistant cache.
get
filecache::get() in caches_filesystem.php
(Plug-in replacement for memcache API) Get data from the persistant cache.
get
xcache::get() in caches_xcache.php
(Plug-in replacement for memcache API) Get data from the persistant cache.
get
JSMin::get() in css_and_js.php
Get the next stream token
get
wincache::get() in caches_wincache.php
(Plug-in replacement for memcache API) Get data from the persistant cache.
getEnabled
FB::getEnabled() in firephp.php
Check if logging is enabled
getOptions
FB::getOptions() in firephp.php
Get options for the library
get_afm_form
get_afm_form() in abstract_file_manager.php
Force an AFM login.
get_afm_form_fields
get_afm_form_fields() in abstract_file_manager.php
Get the fields that need to be filled in to know how to do an AFM connection.
get_base_url
get_base_url() in global2.php
Get the base url (the minimum fully qualified URL to our installation).
get_block_parameters
Gets parameters for a block
get_bot_type
get_bot_type() in support.php
Get the name of a webcrawler bot, or NULL if no bot detected
get_browser_string
get_browser_string() in support.php
Get a string of the users web browser
get_cache_entry
get_cache_entry() in caches.php
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_charset() in global2.php
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_chmod_array() in inst_special.php
Get the list of files that need CHmodding for write access.
get_comcode_zone
get_comcode_zone() in zones.php
Find the zone a comcode page is in.
get_complex_base_url
get_complex_base_url() in global2.php
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
Compressor::get_content() in edit_area_compressor.php
get_cookie_days
get_cookie_days() in global2.php
Get the number of days to store our cookies.
get_cookie_domain
get_cookie_domain() in global2.php
Get the ocPortal cookie domain.
get_cookie_path
get_cookie_path() in global2.php
Get the ocPortal cookie path.
get_css_content
Compressor::get_css_content() in edit_area_compressor.php
get_custom_base_url
get_custom_base_url() in global2.php
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_db_forums() in database.php
Get the name of the forum database.
get_db_forums_host
get_db_forums_host() in database.php
Get the host of the forum database ('localhost', for example).
get_db_forums_password
get_db_forums_password() in database.php
Get the forum database password.
get_db_forums_user
get_db_forums_user() in database.php
Get the forum database username.
get_db_keywords
get_db_keywords() in database_action.php
Returns a list of keywords for all databases we might some day support.
get_db_site
get_db_site() in database.php
Get the name of the database.
get_db_site_host
get_db_site_host() in database.php
Get the host of the database ('localhost', for example).
get_db_site_password
get_db_site_password() in database.php
Get the database password.
get_db_site_user
get_db_site_user() in database.php
Get the database username.
get_db_type
get_db_type() in database.php
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_directory_size() in files2.php
Get the size in bytes of a directory. It is assumed that the directory exists.
get_domain
get_domain() in global2.php
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
get_false_permissions() in database_action.php
Returns a list of pairs, for which permissions are false by default for ordinary usergroups.
get_file_base
get_file_base() in global.php
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_file_size() in files.php
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_flagrant() in support.php
Get the XHTML for the flagrant text message.
get_forum_base_url
get_forum_base_url() in global2.php
Get the installed forum base URL.
get_forum_type
get_forum_type() in global2.php
Get the type of forums installed.
get_function_hash
get_function_hash() in override_api.php
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_gd_version() in images.php
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
Compressor::get_html_content() in edit_area_compressor.php
get_html_trace
get_html_trace() in failure.php
Return a debugging back-trace of the current execution stack. Use this for debugging purposes.
get_input_date
get_input_date() in temporal.php
Check a POST inputted date for validity, and get the Unix timestamp for the inputted date.
get_ip_address
get_ip_address() in support.php
Attempt to get the IP address of the current user
get_javascript_content
Compressor::get_javascript_content() in edit_area_compressor.php
get_lang
get_lang() in lang.php
Get the current language.
get_lang_browser
get_lang_browser() in lang.php
Get the closest fit language code to what the browser is requesting.
get_lang_files
get_lang_files() in lang2.php
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_lang_file_map() in lang_compile.php
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_loaded_tags() in support.php
Get Tempcode for tags, based on loaded up from SEO keywords (seo_meta_load_for).
get_logo_url
get_logo_url() in site.php
Get the relative URL to the logo for the current zone.
get_long_value
get_long_value() in config.php
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_max_file_size() in files2.php
Get the maximum allowed upload filesize, as specified in the configuration
get_max_image_size
get_max_image_size() in images.php
Get the maximum allowed image size, as set in the configuration.
get_member
get_member() in users.php
Get the ID of the currently active member.
get_members_groups
Get a list of usergroups a member is in.
get_members_viewing
get_members_viewing() in support.php
Get a map of members viewing the specified ocPortal location.
get_member_cookie
get_member_cookie() in users.php
Get the member cookie's name.
get_member_email_address
Get a member's e-mail address.
get_microtime
Compressor::get_microtime() in edit_area_compressor.php
get_mime_type
get_mime_type() in mime_types.php
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
get_module_zone() in zones.php
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_num_users_peak() in support.php
Get the largest amount of users ever to be on the site at the same time.
get_num_users_site
get_num_users_site() in support.php
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_ocp_cpf() in users.php
Get the value of a special 'ocp_' custom profile field.
get_online_members
Get database rows of all the online members.
get_option
get_option() in config.php
Find the value of the specified configuration option.
get_os_string
get_os_string() in support.php
Get the user's operating system
get_page_name
get_page_name() in support.php
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_page_title() in templates.php
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
get_page_zone() in zones.php
Find the zone a page is in.
get_param
get_param() in global2.php
Get the value of the specified GET key, if it is found, or the default otherwise.
get_param_integer
get_param_integer() in global2.php
This function is the integeric partner of get_param, as it returns the value as an integer.
get_pass_cookie
get_pass_cookie() in users.php
Get the member password cookie's name.
get_permissions_matrix
get_permissions_matrix() in permissions2.php
Create a form field input matrix for permission setting.
get_permission_fields
Standard modular permission chooser.
get_rand_password
get_rand_password() in support.php
Get a randomised password.
get_relative_timezone
get_relative_timezone() in temporal.php
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
get_remappings() in url_remappings.php
Find the list of URL remappings
get_search_rows
get_search_rows() in database_search.php
Get some rows, queried from the database according to the search parameters.
get_self_url
get_self_url() in urls.php
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_session_id() in users.php
Get the current session ID.
get_site_default_lang
Get the site's default language, with support for URL overrides.
get_site_name
get_site_name() in global2.php
Get the site name.
get_stats_track
get_stats_track() in lookup.php
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_table_prefix() in database.php
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_timezoned_date() in temporal.php
Get a nice formatted date from the specified Unix timestamp.
get_timezoned_time
get_timezoned_time() in temporal.php
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
get_tutorial_link() in config.php
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_url() in uploads.php
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
get_use_persistent() in database.php
Find ocPortal was installed to use persistent database connections or not.
get_value
get_value() in config.php
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_zone_chooser() in zones3.php
Get a zone chooser interface.
get_zone_default_page
Get the default page for a zone.
get_zone_name
get_zone_name() in zones.php
Get the name of the zone the current page request is coming from.
give_submit_points
give_submit_points() in submit.php
Give points to a member for submitting something, then returns the XHTML page to say so.
globalise
globalise() in support.php
Turn the tempcode lump into a standalone page (except for header/footer which is assumed already handled elsewhere).
go
field_restriction_loader::go() in input_filter.php
Run the loader, to load up field-restrictions from the XML file.
group
FB::group() in firephp.php
Start a group for following messages
groupEnd
FB::groupEnd() in firephp.php
Ends a group you have started before
global.php
global.php in global.php
global2.php
global2.php in global2.php
google_analytics.php
google_analytics.php in google_analytics.php
h
top
handle_active_login
handle_active_login() in users_active_actions.php
Process a login.
handle_active_logout
handle_active_logout() in users_active_actions.php
Process a logout.
handle_confirmations
If a confirmation is needed, and not been given, ask for one.
handle_has_checked_recently
Use the url_title_cache table (a bit of a hack but saved changed the DB structure) to see if a check-op was performed has been performed within the last 30 days.
handle_logins
handle_logins() in users.php
Handles an attempted login or logout, and take care of all the sessions and cookies etc.
handle_permission_check_logging
Log permission checks to the permission_checks.log file, if it exists.
handle_symbol_preprocessing
Scan this Tempcode for anything that needs to be symbol-preprocessed
handle_symbol_preprocessing
Certain symbols need preprocessing, before the output stream is made.
has_actual_page_access
has_actual_page_access() in permissions.php
Find if a member's has access to a specified page. Zone permissions are taken into account for wherever the page is found at. Also support for category access and specific permissions. No support for entry-point checks, which are only carried out as an extension of page permissions when actually at a page.
has_category_access
has_category_access() in permissions.php
Find if a member's has access to a specified category
has_cookies
has_cookies() in support.php
Determine whether the user's browser supports cookies or not.
has_delete_permission
has_delete_permission() in permissions.php
Check to see if a member's has permission to delete a specific resource
has_edit_permission
has_edit_permission() in permissions.php
Find if a member's has permission to edit
has_js
has_js() in support.php
Determine whether the user's browser supports JavaScript or not.
has_no_forum
has_no_forum() in support.php
Find whether we have no forum on this website.
has_page_access
has_page_access() in permissions.php
Find if a member's has access to a specified page, in a specific zone. Note that page access does not imply zone access; you have access a page, but not the zone, so still couldn't see it.
has_some_cat_specific_permission
Find if a member has a specified permission in any category
has_specific_permission
has_specific_permission() in permissions.php
Find if a member has a specified permission
has_specific_permission_group
Find if a group has a specified permission
has_submit_permission
has_submit_permission() in permissions.php
Find if a member's has permission to submit
has_zone_access
has_zone_access() in permissions.php
Find if a member's has access to a specified zone
hide_the_evidence
hide_the_evidence() in xhtml.php
Function that tucks-under-the-carpet lumps of XHTML that knowingly won't validate.
HIPHOP_PHP
HIPHOP_PHP in global.php
Hook_addon_registry_core
Hook_config_default_advanced_admin_cache
Hook_config_default_advanced_admin_cache in advanced_admin_cache.php
Hook_config_default_check_broken_urls
Hook_config_default_check_broken_urls in check_broken_urls.php
Hook_config_default_collapse_user_zones
Hook_config_default_collapse_user_zones in collapse_user_zones.php
Hook_config_default_filesystem_caching
Hook_config_default_filesystem_caching in filesystem_caching.php
Hook_config_default_google_analytics
Hook_config_default_google_analytics in google_analytics.php
Hook_config_default_sms_api_id
Hook_config_default_sms_high_limit
Hook_config_default_sms_high_trigger_limit
Hook_config_default_sms_high_trigger_limit in sms_high_trigger_limit.php
Hook_config_default_sms_low_limit
Hook_config_default_sms_low_trigger_limit
Hook_config_default_sms_low_trigger_limit in sms_low_trigger_limit.php
Hook_config_default_sms_password
Hook_config_default_sms_username
Hook_config_default_url_monikers_enabled
Hook_config_default_url_monikers_enabled in url_monikers_enabled.php
Hook_cron_sitemap
Hook_cron_sitemap in sitemap.php
Hook_do_next_menus_core
Hook_Preview_block_comcode
Hook_Preview_block_comcode in block_comcode.php
httpauth_login
httpauth_login() in users_inactive_occasionals.php
Try and login via HTTP authentication. This function is only called if HTTP authentication is currently active. With HTTP authentication we trust the PHP_AUTH_USER setting.
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.
hyperlink
hyperlink() in templates.php
Get the tempcode for a hyperlink.
i
top
$input
JSMin::$input in css_and_js.php
$inputIndex
JSMin::$inputIndex in css_and_js.php
$inputLength
JSMin::$inputLength in css_and_js.php
index.php
index.php in index.php
index.php
index.php in index.php
iframe.php
iframe.php in iframe.php
incoming_uploads.php
incoming_uploads.php in incoming_uploads.php
iframe_script
iframe_script() in misc_scripts.php
Script to handle iframe.
import_from_xml
import_from_xml() in xml_storage.php
Import to ocPortal database table from the equivalent XML format.
improperly_filled_in
improperly_filled_in() in failure.php
Complain about a field being missing.
improperly_filled_in_post
Complain about a POST field being missing.
incoming_uploads_script
incoming_uploads_script() in incoming_uploads.php
Function to process the file upload process
index.php
index.php in index.php
info
Block_main_greeting::info() in main_greeting.php
Standard modular info function.
info
Block_main_facebook_like::info() in main_facebook_like.php
Standard modular info function.
info
Standard modular info function.
info
Module_forums::info() in forums.php
Standard modular info function.
info
Block_main_facebook_facepile::info() in main_facebook_facepile.php
Standard modular info function.
info
FB::info() in firephp.php
Log object with label to firebug console
info
Standard modular info function.
info
Module_admin_version::info() in admin_version.php
Standard modular info function.
info
Block_main_comcode_page_children::info() in main_comcode_page_children.php
Standard modular info function.
info
Block_main_db_notes::info() in main_db_notes.php
Standard modular info function.
info
Block_main_facebook_comments::info() in main_facebook_comments.php
Standard modular info function.
info
Block_main_as_zone_access::info() in main_as_zone_access.php
Standard modular info function.
info
Module_admin_emaillog::info() in admin_emaillog.php
Standard modular info function.
info
Module_admin_lookup::info() in admin_lookup.php
Standard modular info function.
info
Block_main_include_module::info() in main_include_module.php
Standard modular info function.
info
Block_main_sitemap::info() in main_sitemap.php
Standard modular info function.
info
Standard modular info function.
info
Block_side_personal_stats::info() in side_personal_stats.php
Standard modular info function.
info
Block_main_only_if_match::info() in main_only_if_match.php
Standard modular info function.
info
Block_side_facebook_activity::info() in side_facebook_activity.php
Standard modular info function.
info
standard_aed_module::info() in aed_module.php
Standard modular info function.
info
Block_main_notes::info() in main_notes.php
Standard modular info function.
inform_exit
inform_exit() in global2.php
This is a intended to output an informational exit at the same time as terminating execution
inform_screen
inform_screen() in templates.php
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
init__abstract_file_manager() in abstract_file_manager.php
Standard code module initialisation function.
init__ajax
init__ajax() in ajax.php
Standard code module initialisation function.
init__caches
init__caches() in caches.php
Standard code module initialisation function.
init__config
init__config() in config.php
Standard code module initialisation function.
init__database
init__database() in database.php
Standard code module initialisation function.
init__database_search
init__database_search() in database_search.php
Standard code module initialisation function.
init__developer_tools
init__developer_tools() in developer_tools.php
Standard code module initialisation function.
init__failure
init__failure() in failure.php
Standard code module initialisation function.
init__files
init__files() in files.php
Standard code module initialisation function.
init__files2
init__files2() in files2.php
Standard code module initialisation function.
init__forum_stub
init__forum_stub() in forum_stub.php
Standard code module initialisation function.
init__global2
init__global2() in global2.php
Standard code module initialisation function.
init__lang
init__lang() in lang.php
Standard code module initialisation function.
init__lang_compile
init__lang_compile() in lang_compile.php
Standard code module initialisation function.
init__lookup
init__lookup() in lookup.php
Standard code module initialisation function.
init__mail
init__mail() in mail.php
Standard code module initialisation function.
init__minikernel
init__minikernel() in minikernel.php
Standard code module initialisation function.
init__m_zip
init__m_zip() in m_zip.php
Standard code module initialisation function.
init__obfuscate
init__obfuscate() in obfuscate.php
Standard code module initialisation function.
init__permissions
init__permissions() in permissions.php
Standard code module initialisation function.
init__site
init__site() in site.php
Standard code module initialisation function.
init__sitemap
init__sitemap() in sitemap.php
Standard code module initialisation function.
init__support
init__support() in support.php
Standard code module initialisation function.
init__symbols
init__symbols() in symbols.php
Standard code module initialisation function.
init__tempcode
init__tempcode() in tempcode.php
Standard code module initialisation function.
init__tempcode_compiler
init__tempcode_compiler() in tempcode_compiler.php
Standard code module initialisation function.
init__tempcode__runtime
init__tempcode__runtime() in tempcode__runtime.php
Standard code module initialisation function.
init__templates
init__templates() in templates.php
Standard code module initialisation function.
init__temporal
init__temporal() in temporal.php
Standard code module initialisation function.
init__themes
init__themes() in themes.php
Standard code module initialisation function.
init__uploads
init__uploads() in uploads.php
Standard code module initialisation function.
init__urls
init__urls() in urls.php
Standard code module initialisation function.
init__users
init__users() in users.php
Standard code module initialisation function.
init__word_filter
init__word_filter() in word_filter.php
Standard code module initialisation function.
init__zones
init__zones() in zones.php
Standard code module initialisation function.
init__zones2
init__zones2() in zones2.php
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_lang() in lang.php
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
inspect() in developer_tools.php
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
inspect_plain() in developer_tools.php
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
Module_admin_version::install() in admin_version.php
Standard modular install function.
integer_format
integer_format() in support.php
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
invert_value() in config.php
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
in_memory_search_match() in database_search.php
Perform a database-style in-memory boolean search on single item.
in_safe_mode
in_safe_mode() in global2.php
Find whether we are running in safe mode.
ip_banned
ip_banned() in support2.php
Check to see if an IP address is banned.
isAlphaNum
JSMin::isAlphaNum() in css_and_js.php
Find whether a character is alphanumeric
is_alphanumeric
is_alphanumeric() in type_validation.php
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
is_data_encrypted() in encryption.php
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
ocp_tempcode::is_empty() in tempcode.php
Find whether the current tempcode object is blank or not.
is_encryption_available
is_encryption_available() in encryption.php
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
is_encryption_enabled() in encryption.php
Determine whether encryption support is available and enabled in the site's preferences, and the keys are in place.
is_guest
is_guest() in minikernel.php
Find whether the current member is a guest.
is_httpauth_login
is_httpauth_login() in users.php
Find whether the current member is logged in via httpauth.
is_image
is_image() in images.php
Find whether the image specified is actually an image, based on file extension
is_mobile
is_mobile() in support.php
Look at the user's browser, and decide if they are viewing on a mobile device or not.
is_page_https
is_page_https() in urls.php
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
is_saveable_image() in images.php
Use the image extension to determine if the specified image is of a format (extension) saveable by ocPortal or not.
is_special_file
is_special_file() in files.php
Find whether a file should be ignored.
is_staff
Find whether a member is staff.
is_suexec_like
is_suexec_like() in files.php
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
is_swf_upload() in uploads.php
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
is_valid_email_address() in type_validation.php
Find whether the specified address is a valid e-mail address or not.
is_video
is_video() in images.php
Find whether the video specified is actually an video, based on file extension
is_wide
is_wide() in support.php
Find whether panels will be shown.
is_wide_high
is_wide_high() in support.php
Find whether panels and the header/footer areas won't be shown.
is_writable_wrap
is_writable_wrap() in support.php
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
index.php in index.php
images.php
images.php in images.php
incoming_uploads.php
incoming_uploads.php in incoming_uploads.php
input_filter.php
input_filter.php in input_filter.php
inst_special.php
inst_special.php in inst_special.php
integrator.php
integrator.php in integrator.php
j
top
$javascript
$javascript_require
javascript.php
javascript.php in javascript.php
javascript_enforce
javascript_enforce() in global2.php
Force a Javascript file to be cached (ordinarily we can rely on this to be automated by require_javascript/javascript_tempcode).
javascript_tempcode
javascript_tempcode() in global2.php
Get tempcode to tie in (to the HTML, in <head>) all the Javascript files that have been required.
join_link
Get a URL to a forum join page.
JSMin
JSMin in css_and_js.php
JSMin
JSMin::JSMin() in css_and_js.php
Constructor function
js_compile
js_compile() in css_and_js.php
Compile a Javascript file.
js_minify
js_minify() in css_and_js.php
Minimise the given Javascript
k
top
keep_symbol
keep_symbol() in symbols.php
String to tack onto URL to keep 'keep_' parameters
l
top
$last_attach
$levels_from_filtered
$lookAhead
JSMin::$lookAhead in css_and_js.php
lang_code_to_default_content
Convert the specified language codename to the default content, and return the language key.
lang_remap
lang_remap() in lang.php
Remap the specified language id, and return the id again - the id isn't changed.
lang_remap_comcode
Remap the specified comcode language id, and return the id again - the id isn't changed.
list_to_map
list_to_map() in support.php
Take a list of maps, and make one of the values of each array the index of a map to the map
load_comcode_page
Get the parsed contents of a comcode page.
load_field_restrictions
load_field_restrictions() in input_filter.php
Find all restrictions that apply to our page/type.
load_files
Compressor::load_files() in edit_area_compressor.php
load_html_page
load_html_page() in site_html_pages.php
Get the contents of an HTML page.
load_minimodule_page
Runs the specified mini-module.
load_module_page
load_module_page() in zones.php
Runs the specified module, but also update any stats for the module, and check to see if it needs upgrading or reinstalling.
load_moniker_hooks
Load up hooks needed to detect how to use monikers.
load_options
load_options() in config.php
Load all config options.
load_template_script
AJAX script for getting the text of a template, as used by a certain theme.
load_up_all_module_category_permissions
For efficiency reasons, load up loads of category permissions.
load_up_all_self_page_permissions
For efficiency reasons, load up loads of page permissions.
load_user_stuff
load_user_stuff() in global2.php
Load stuff that allows user code to work.
locale_filter
locale_filter() in temporal.php
Filter locale-tainted strings through the locale filter.
log
FB::log() in firephp.php
Log object with label to firebug console
login_after
The actualiser for logging in.
login_before
The UI for logging in.
logout
The actualiser for logging out.
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_it() in support.php
Log an action
log_stats
log_stats() in site.php
Log statistics for the page view.
looks_like_url
looks_like_url() in urls.php
Find if a value appears to be some kind of URL (possibly an ocPortalised Comcode one).
lookup_language_full_name
Get the full name of a language. e.g. 'EN' would become 'English'
lookup_member_page
lookup_member_page() in lookup.php
Get information about the specified member.
login.php
login.php in login.php
lang.php
lang.php in lang.php
lang2.php
lang2.php in lang2.php
lang3.php
lang3.php in lang3.php
lang_compile.php
lang_compile.php in lang_compile.php
lang_urlise.php
lang_urlise.php in lang_urlise.php
lookup.php
lookup.php in lookup.php
m
top
$MEMBER_ROWS_CACHED
$menu_label
$module_type
mail_wrap
mail_wrap() in mail.php
Attempt to send an e-mail to the specified recipient. The mail will be forwarding to the CC address specified in the options (if there is one, and if not specified not to cc).
make_csv
make_csv() in files2.php
Output data to a CSV file.
make_locale_filter
make_locale_filter() in temporal.php
Set up the locale filter array from the terse language string specifying it.
make_map_nice
make_map_nice() in xml_storage.php
Take a PHP map array, and make it look nice.
make_seed
make_seed() in global2.php
A custom random number seed generator. It returns a random number seed.
make_sentence_case_callback
make_sentence_case_callback() in input_filter.php
preg_replace callback to apply sentence case.
make_string_tempcode
make_string_tempcode() in tempcode.php
Convert a string to tempcode.
make_xhtml_strict
make_xhtml_strict() in support.php
Take a Tempcode object and run some hackerish code to make it XHTML-strict.
mass_delete
Actualiser to do a mass send.
mass_delete_lang
mass_delete_lang() in database_action.php
Deletes all language codes linked to by the specified table and attribute identifiers, if they exist.
mass_send
Actualiser to do a mass send.
match_key_match
match_key_match() in support.php
See if the current URL matches the given ocPortal match tags.
may_see_stack_dumps
may_see_stack_dumps() in failure.php
Find whether the current user may see stack dumps.
member_blocked
member_blocked() in users.php
Find if a member is blocked by a member.
member_is_online
member_is_online() in users.php
Find if a member is online.
member_pm_link
Get a URL to send a forum member a PM.
member_profile_hyperlink
Get a hyperlink (i.e. HTML link, not just a URL) to a forum member's member profile.
member_profile_link
Get a URL to a forum member's member profile.
member_tracking_update
Update the member tracker for the currently viewing user.
memory_trace_point
memory_trace_point() in developer_tools.php
Record the memory usage at this point.
microtime_diff
microtime_diff() in database.php
Get the time difference in microseconds between two PHP microtimes.
min
JSMin::min() in css_and_js.php
Do minification process
mixed
mixed() in support.php
Assign this to explicitly declare that a variable may be of mixed type, and initialise to NULL.
Module_admin
Module_admin in admin.php
Module page class.
Module_admin_emaillog
Module_admin_emaillog in admin_emaillog.php
Module page class.
Module_admin_lookup
Module_admin_lookup in admin_lookup.php
Module page class.
Module_admin_version
Module_admin_version in admin_version.php
Module page class.
Module_cms
Module_cms in cms.php
Module page class.
Module_forums
Module_forums in forums.php
Module page class.
module_installed
module_installed() in zones.php
Check to see if a module is installed.
Module_login
Module_login in login.php
Module page class.
multi_lang
multi_lang() in config.php
Find whether to run in multi-lang mode.
multi_sort
multi_sort() in support.php
Helper function to sort a list of maps by the value at $key in each of those maps.
my_md5
my_md5() in users.php
Apply hashing to some input. To this date, all forum drivers use md5, but some (well, currently SMF) use it differently.
my_strftime
my_strftime() in temporal.php
Format a local time/date according to locale settings. Combines best features of 'strftime' and 'date'.
main_as_zone_access.php
main_as_zone_access.php in main_as_zone_access.php
main_comcode_page_children.php
main_comcode_page_children.php in main_comcode_page_children.php
main_db_notes.php
main_db_notes.php in main_db_notes.php
main_greeting.php
main_greeting.php in main_greeting.php
main_include_module.php
main_include_module.php in main_include_module.php
main_notes.php
main_notes.php in main_notes.php
main_only_if_match.php
main_only_if_match.php in main_only_if_match.php
main_sitemap.php
main_sitemap.php in main_sitemap.php
mail.php
mail.php in mail.php
mime_types.php
mime_types.php in mime_types.php
minikernel.php
minikernel.php in minikernel.php
misc_scripts.php
misc_scripts.php in misc_scripts.php
m_zip.php
m_zip.php in m_zip.php
main_facebook_comments.php
main_facebook_comments.php in main_facebook_comments.php
main_facebook_facepile.php
main_facebook_facepile.php in main_facebook_facepile.php
main_facebook_like.php
main_facebook_like.php in main_facebook_like.php
n
top
$namespace_stack
$new_id
$non_integer_id
$no_blank_ids
namelike_script
namelike_script() in ajax.php
AJAX script for allowing username/author/search-terms home-in.
next
JSMin::next() in css_and_js.php
Get the next item in the stream
nice_get_entries
Standard modular entry list fetcher.
nice_get_langs
nice_get_langs() in lang.php
Get a nice formatted XHTML listed language selector.
nice_get_lang_files
Get a nice formatted XHTML listed language file selector for the given language.
nice_get_zones
nice_get_zones() in zones3.php
Get a list of zones.
o
top
$orderer
$organisation
$output
JSMin::$output in css_and_js.php
$output_of_action_is_confirmation
obfuscate_email_address
obfuscate_email_address() in obfuscate.php
Obfuscate the given e-mail address.
obfuscate_entities
obfuscate_entities() in obfuscate.php
Obfuscate the given text using HTML entity encoding.
object_factory
object_factory() in global.php
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
ocfilter_to_sqlfragment() in ocfiltering.php
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
ocportal_cleanup() in view_modes.php
Rebuild the specified caches.
ocportal_error_handler
ocPortal error handler (hooked into PHP error system).
ocp_admirecookie
ocp_admirecookie() in users.php
Get a cookie value.
ocp_eatcookie
ocp_eatcookie() in users.php
Deletes a cookie (if it exists), from within ocPortal's cookie environment.
ocp_mb_strlen
ocp_mb_strlen() in support.php
Get string length, with utf-8 awareness where possible/required.
ocp_mb_strtolower
ocp_mb_strtolower() in support.php
Make a string lowercase, with utf-8 awareness where possible/required.
ocp_mb_strtoupper
ocp_mb_strtoupper() in support.php
Make a string uppercase, with utf-8 awareness where possible/required.
ocp_mb_substr
ocp_mb_substr() in support.php
Return part of a string, with utf-8 awareness where possible/required.
ocp_setcookie
ocp_setcookie() in users_active_actions.php
Create a cookie, inside ocPortal's cookie environment.
ocp_simple_xml_reader
ocp_simple_xml_reader in xml_storage.php
ocp_simple_xml_reader
Constructs the XML reader: parses the given data. Check $gleamed and $error after constructing.
ocp_srv
ocp_srv() in support.php
Get server environment variables.
ocp_tempcode
ocp_tempcode in tempcode.php
ocp_tempcode
Constructor of tempcode
ocp_tempnam
ocp_tempnam() in support.php
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
ocp_url_encode() in urls.php
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
ocp_version() in version.php
Get the major version of your installation.
ocp_version_full
ocp_version_full() in global2.php
Get the full string version of ocPortal that you are running.
ocp_version_minor
ocp_version_minor() in version.php
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
ocp_version_number() in version.php
Get the general version number of your installation (incorporates major and minor verson number).
ocp_version_time
ocp_version_time() in version.php
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
opensearch_script() in database_search.php
Server opensearch requests.
obfuscate.php
obfuscate.php in obfuscate.php
ocfiltering.php
ocfiltering.php in ocfiltering.php
override_api.php
override_api.php in override_api.php
p
top
$permissions_cat_name
$permissions_cat_name_b
$permissions_cat_require
$permissions_cat_require_b
$permissions_require
$permission_module
$permission_page
$possibly_some_kind_of_upload
$posting_form_text
$posting_form_text_parsed
$posting_form_title
$preprocessable_bits
$protect_first
$pure_lang
ocp_tempcode::$pure_lang in tempcode.php
pagelink_redirect.php
pagelink_redirect.php in pagelink_redirect.php
pagelink_redirect_script
pagelink_redirect_script() in misc_scripts.php
Redirect the browser to where a pagelink specifies.
pagelink_to_sitemapsxml
Callback for writing a page-link into the Sitemaps XML file.
page_link_chooser_script
page_link_chooser_script() in misc_scripts.php
Outputs the page link chooser popup.
page_link_decode
page_link_decode() in urls.php
Take a page link and convert to attributes and zone.
page_not_found
page_not_found() in site2.php
Render that the page wasn't found. Show alternate likely candidates based on misspellings.
page_path_to_pagelink
Convert a local page file path to a written page-link.
paragraph
paragraph() in templates.php
Get the tempcode for a paragraph. This function should only be used with escaped text strings that need to be put into a paragraph, not with sections of HTML. Remember, paragraphs are literally that, and should only be used with templates that don't assume that they are going to put the given parameters into paragraphs themselves.
parameterless
Find whether a variable within this Tempcode is parameterless.
parse_from
Parse a single symbol from an input stream and append it.
parse_translated_text
get_translated_tempcode was asked for a lang entry that had not been parsed into Tempcode yet.
peek
JSMin::peek() in css_and_js.php
Find what's next in the stream
permission_exists
permission_exists() in database_action.php
Check if a specific permission exists.
persistant_cache_delete
Delete data from the persistant cache.
persistant_cache_empty
Remove all data from the persistant cache.
persistant_cache_get
Get data from the persistant cache.
persistant_cache_set
Put data into the persistant cache.
php_addslashes
php_addslashes() in support.php
Escape a string to fit within PHP double quotes.
php_addslashes_twice
php_addslashes_twice() in tempcode.php
Escape a string to fit within PHP double quotes TWICE. Needed sometimes when generating code. This function exists for performance reasons.
post_param
post_param() in global2.php
Get the value of the specified POST key, if it is found, or the default otherwise.
post_param_integer
post_param_integer() in global2.php
This function is the integeric partner of post_param, as it returns the value as an integer.
prepare_string_for_quotes
Compressor::prepare_string_for_quotes() in edit_area_compressor.php
preview_intercept
Standard modular UI for a separate preview.
preview_script
preview_script() in misc_scripts.php
Script to show previews of content being added/edited.
promote_text_field_to_comcode
If a text field has picked up Comcode support, we will need to run this.
protect_from_escaping
Stop some text being escapable by the Tempcode layer.
pull_together
Pull a portion of an XML tree structure back into textual XML.
put_into_cache
put_into_cache() in caches2.php
Put a result into the cache.
put_in_standard_box
put_in_standard_box() in templates.php
Get the tempcode for a standard box (CSS driven), with the specified content entered. Please rarely use this function; it is not good to assume people want anythings in one of these boxes... use templates instead
permissions.php
permissions.php in permissions.php
permissions2.php
permissions2.php in permissions2.php
q
top
quash_referer.php
quash_referer.php in quash_referer.php
question_ui.php
question_ui.php in question_ui.php
qualify_url
qualify_url() in urls.php
Take a URL and base-URL, and fully qualify the URL according to it.
query
database_driver::query() in database.php
This function is a very basic query executor. It shouldn't usually be used by you, as there are abstracted versions available (see below).
query_delete
Deletes rows from the specified table, that match the specified conditions (if any). It may be limited to a row range (it is likely, only a maximum, of 1, will be used, if any kind of range at all).
query_insert
Insert a row.
query_select
Get the DB results found from the specified parameters.
query_update
Update (edit) a row in the database.
query_value
Get the specified value from the database. This is a first value of the first row returned.
query_value_null_ok
Get the specified value from the database, or NULL if it is not there (or if the value itself is NULL). This is good for detection existence of records, or for use if they might may or may not be present.
query_value_null_ok_full
This function is a variant of query_value_null_ok, by the fact that it only accepts a complete (and perfect) SQL query, instead of assembling one itself from the specified parameters.
question_ui_script
question_ui_script() in misc_scripts.php
Outputs a modal question dialog.
r
top
$redirect_type
read_multi_code
read_multi_code() in support.php
Read a multi code from a named parameter stub.
read_text_file
read_text_file() in textfiles.php
Read a text file, using the _custom system
redirect_screen
redirect_screen() in templates.php
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_block() in zones2.php
Reinstall a block if it has become corrupted for any reason.
reinstall_module
reinstall_module() in zones2.php
Reinstall the specified module.
relay_error_mail
relay_error_mail() in failure.php
Relay an error message, if appropriate, to e-mail listeners (sometimes ocProducts, and site staff).
remove_code
remove_code() in override_api.php
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_ip_ban() in failure.php
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
Compressor::replace_scripts() in edit_area_compressor.php
reprocess_url
reprocess_url() in integrator.php
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
request_page() in site.php
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
require_all_lang() in lang.php
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
require_code() in global.php
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
require_css() in global2.php
Make sure that the given CSS file is loaded up.
require_javascript
require_javascript() in global2.php
Make sure that the given javascript file is loaded up.
require_lang
require_lang() in lang.php
Includes a language file for use in the script.
require_lang_compile
require_lang_compile() in lang_compile.php
Load up a language file, compiling it (it's not cached yet).
restricted_manually_enabled_backdoor
restricted_manually_enabled_backdoor() in users_active_actions.php
Backdoor handler. Can only be activated by those with FTP write-access.
restrictify
restrictify() in developer_tools.php
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 in rss.php
rss
rss::rss() in rss.php
Constructs the RSS reader: downloads the URL and parses it. Check $error after constructing.
run
Module_admin_version::run() in admin_version.php
Standard modular run function.
run
standard_aed_module::run() in aed_module.php
Standard modular run function.
run
Block_side_facebook_activity::run() in side_facebook_activity.php
Standard modular run function.
run
Standard modular run function for CRON hooks. Searches for tasks to perform.
run
Module_admin_lookup::run() in admin_lookup.php
Standard modular run function.
run
Block_side_personal_stats::run() in side_personal_stats.php
Standard modular run function.
run
Module_admin_emaillog::run() in admin_emaillog.php
Standard modular run function.
run
Block_main_comcode_page_children::run() in main_comcode_page_children.php
Standard modular run function.
run
Module_login::run() in login.php
Standard modular run function.
run
Block_main_as_zone_access::run() in main_as_zone_access.php
Standard modular run function.
run
Block_main_db_notes::run() in main_db_notes.php
Standard modular run function.
run
Module_admin::run() in admin.php
Standard modular run function.
run
Module_forums::run() in forums.php
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
Block_main_facebook_comments::run() in main_facebook_comments.php
Standard modular run function.
run
Block_main_facebook_facepile::run() in main_facebook_facepile.php
Standard modular run function.
run
Block_main_sitemap::run() in main_sitemap.php
Standard modular run function.
run
Standard modular run function for preview hooks.
run
Block_main_only_if_match::run() in main_only_if_match.php
Standard modular run function.
run
Block_main_notes::run() in main_notes.php
Standard modular run function.
run
Block_main_facebook_like::run() in main_facebook_like.php
Standard modular run function.
run
Block_main_greeting::run() in main_greeting.php
Standard modular run function.
run
Block_main_include_module::run() in main_include_module.php
Standard modular run function.
running_script
running_script() in global2.php
Find whether a certain script is being run to get here.
rss.php
rss.php in rss.php
s
top
$second_stage_preview
$select_name_description
$send_validation_request
$seo_type
$seq_parts
ocp_tempcode::$seq_parts in tempcode.php
$skip_validation
$special_edit_frontend
$static_ob
sheet.php
sheet.php in sheet.php
site_tree.php
site_tree.php in site_tree.php
sms.php
sms.php in sms.php
snippet.php
snippet.php in snippet.php
search
Actualiser to perform Admin Zone search.
send
FB::send() in firephp.php
Log object to firebug
send_datas
Compressor::send_datas() in edit_area_compressor.php
send_headers
Compressor::send_headers() in edit_area_compressor.php
send_validation_request
Send (by e-mail) a validation request for a submitted item to the admin.
seo_get_fields
seo_get_fields() in seo2.php
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
seo_meta_get_for() in support.php
Get meta information for specified resource
seo_meta_load_for
seo_meta_load_for() in support.php
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
servertime_to_usertime() in temporal.php
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
wincache::set() in caches_wincache.php
(Plug-in replacement for memcache API) Put data into the persistant cache.
set
apccache::set() in caches_apc.php
(Plug-in replacement for memcache API) Put data into the persistant cache.
set
filecache::set() in caches_filesystem.php
(Plug-in replacement for memcache API) Put data into the persistant cache.
set
xcache::set() in caches_xcache.php
(Plug-in replacement for memcache API) Put data into the persistant cache.
set
eacceleratorcache::set() in caches_eaccelerator.php
(Plug-in replacement for memcache API) Put data into the persistant cache.
setEnabled
FB::setEnabled() in firephp.php
Enable and disable logging to Firebug
setObjectFilter
FB::setObjectFilter() in firephp.php
Specify a filter to be used when encoding an object
setOptions
FB::setOptions() in firephp.php
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_long_value() in config.php
Set the specified situational value to the specified long value.
set_option
set_option() in config2.php
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_session_id() in users_inactive_occasionals.php
Set the session ID of the user.
set_specific_permission
set_specific_permission() in database_action.php
Sets the specific-permission of a usergroup
set_tutorial_link
set_tutorial_link() in config.php
Set the specified value to the specified tutorial link identifier.
set_value
set_value() in config.php
Set the specified situational value to the specified value.
sheet_script
sheet_script() in ajax.php
AJAX script for dynamic inclusion of CSS.
show
Module_admin_emaillog::show() in admin_emaillog.php
Get a list of all the e-mails sent/queued.
show_memory_points
show_memory_points() in developer_tools.php
Output whatever memory points we collected up.
shuffle_for
shuffle_for() in support2.php
Shuffle an array into an array of columns.
simple_tracker_script
simple_tracker_script() in misc_scripts.php
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
sitemaps_build() in sitemap.php
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
site_tree_script() in site_tree.php
AJAX script for dynamically extended sitetree.
skippable_keep
skippable_keep() in urls.php
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
sms_wrap() in mail.php
Attempt to send an SMS.
snippet_script
snippet_script() in ajax.php
AJAX script for dynamic inclusion of XHTML snippets.
sort_search_results
sort_search_results() in database_search.php
Sort search results as returned by the search hook.
side_personal_stats.php
side_personal_stats.php in side_personal_stats.php
sms_api_id.php
sms_api_id.php in sms_api_id.php
sms_high_limit.php
sms_high_limit.php in sms_high_limit.php
sms_high_trigger_limit.php
sms_high_trigger_limit.php in sms_high_trigger_limit.php
sms_low_limit.php
sms_low_limit.php in sms_low_limit.php
sms_low_trigger_limit.php
sms_low_trigger_limit.php in sms_low_trigger_limit.php
sms_password.php
sms_password.php in sms_password.php
sms_username.php
sms_username.php in sms_username.php
sitemap.php
sitemap.php in sitemap.php
seo2.php
seo2.php in seo2.php
shared_installs.php
shared_installs.php in shared_installs.php
site.php
site.php in site.php
site2.php
site2.php in site2.php
sitemap.php
sitemap.php in sitemap.php
site_adminzone.php
site_adminzone.php in site_adminzone.php
site_html_pages.php
site_html_pages.php in site_html_pages.php
site_tree.php
site_tree.php in site_tree.php
splurgh.php
splurgh.php in splurgh.php
submit.php
submit.php in submit.php
support.php
support.php in support.php
support2.php
support2.php in support2.php
symbols.php
symbols.php in symbols.php
side_facebook_activity.php
side_facebook_activity.php in side_facebook_activity.php
spawn_page_crawl
spawn_page_crawl() in sitemap.php
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
special_page_types() in view_modes.php
Handle special page type output.
splurgh_master_build
splurgh_master_build() in splurgh.php
Get a splurghified version of the specified item.
staff_tips_script
staff_tips_script() in misc_scripts.php
Outputs the staff tips iframe.
standard_aed_module
standard_aed_module in aed_module.php
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
rss::startText() in rss.php
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
store_autosave() in ajax.php
AJAX script to store an autosave.
strlen_sort
strlen_sort() in support.php
Helper function for usort to sort a list by string length.
suggest_fatalistic
suggest_fatalistic() in global2.php
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
su_login() in users_inactive_occasionals.php
Filter a member ID through SU, if SU is on and if the user has permission.
symbol_tempcode
symbol_tempcode() in tempcode.php
This will create a new tempcode object that is containing a single specifed symbol
symbol_truncator
symbol_truncator() in symbols.php
Handle truncation symbols in all their complexity
sync_file
sync_file() in global2.php
Provides a hook for file synchronisation between mirrored servers. Called after any file creation, deletion or edit.
sync_file_move
sync_file_move() in global2.php
Provides a hook for file-move synchronisation between mirrored servers. Called after any rename or move action.
t
top
$table
standard_aed_module::$table in aed_module.php
$table_exists_cache
$table_prefix
$table_prefix
$tag_stack
rss::$tag_stack in rss.php
$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
rss::$type in rss.php
$type_code
tar.php
tar.php in tar.php
tempcode.php
tempcode.php in tempcode.php
tempcode_compiler.php
tempcode_compiler.php in tempcode_compiler.php
tempcode_compiler__runtime.php
tempcode_compiler__runtime.php in tempcode_compiler__runtime.php
tempcode__runtime.php
tempcode__runtime.php in tempcode__runtime.php
templates.php
templates.php in templates.php
temporal.php
temporal.php in temporal.php
temporal2.php
temporal2.php in temporal2.php
textfiles.php
textfiles.php in textfiles.php
themes.php
themes.php in themes.php
type_validation.php
type_validation.php in type_validation.php
table
FB::table() in firephp.php
Log a table in the firebug console
table_exists
Check if a table exists.
tar_add_file
tar_add_file() in tar.php
Add a file to the specified TAR file.
tar_add_folder
tar_add_folder() in tar.php
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
tar_close() in tar.php
Close an open TAR resource.
tar_crc
tar_crc() in tar.php
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
tar_get_file() in tar.php
Get the contents of the specified file in the specified TAR.
tar_open
tar_open() in tar.php
Open up a TAR archive, and return the resource.
template_to_tempcode
template_to_tempcode() in tempcode_compiler.php
Convert template text into tempcode format.
thumb_script
thumb_script() in misc_scripts.php
Allows conversion of a URL to a thumbnail via a simple script.
tick_func
tick_func() in index.php
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
FB::trace() in firephp.php
Log a trace in the firebug console
trueStartText
Parse the complete text of the inside of the tag.
u
top
$upload
$user_facing
url_monikers_enabled.php
url_monikers_enabled.php in url_monikers_enabled.php
uploads.php
uploads.php in uploads.php
urls.php
urls.php in urls.php
urls2.php
urls2.php in urls2.php
url_remappings.php
url_remappings.php in url_remappings.php
users.php
users.php in users.php
users_active_actions.php
users_active_actions.php in users_active_actions.php
users_inactive_occasionals.php
users_inactive_occasionals.php in users_inactive_occasionals.php
unban_ip
unban_ip() in submit.php
Unban the specified IP address.
uninstall
Standard modular uninstall function.
uninstall
Standard modular uninstall function.
uninstall_block
uninstall_block() in zones2.php
This function totally uninstalls a block from the system. Yet again, you should not need to use this function.
uninstall_module
uninstall_module() in zones2.php
Completely uninstall the specified module from the system.
unixify_line_format
unixify_line_format() in global2.php
Make sure that lines are seperated by chr(10), with no chr(13)'s there at all. For Mac data, this will be a flip scenario. For Linux data this will be a null operation. For windows data this will be change from chr(13).chr(10) to just chr(10). For a realistic scenario, data could have originated on all kinds of platforms, with some editors converting, some situations being inter-platform, and general confusion. Don't make blind assumptions - use this function to clean data, then write clean code that only considers chr(10)'s.
update_stat
update_stat() in config.php
Increment the specified stored value, by the specified amount.
upgrade_block
upgrade_block() in zones2.php
Upgrades a block to the latest version available on your ocPortal installation. [b]This function can only upgrade to the latest version put into the block directory.[/b] You should not need to use this function.
upgrade_module
upgrade_module() in zones2.php
Upgrade the specified module.
urlise_lang
urlise_lang() in lang.php
URL'ise specially encoded text-acceptance language strings.
url_is_local
url_is_local() in urls.php
Find if the specified URL is local or not (actually, if it is relative). This is often used by code that wishes to use file system functions on URLs (ocPortal will store such relative local URLs for uploads, etc)
url_monikers_enabled
Find whether URL monikers are enabled.
url_to_filename
url_to_filename() in urls.php
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
url_to_pagelink() in urls.php
Convert a local URL to a page-link.
username_check_script
AJAX script for checking if a new username is valid.
username_exists_script
AJAX script for checking if a username exists.
usertime_to_servertime
usertime_to_servertime() in temporal.php
Convert a user timestamp to a server timestamp. This is not a function to use much- you probably want servertime_to_usertime.
user_lang
user_lang() in lang.php
Get the user's currently selected language.
v
top
$version
rss::$version in rss.php
$view_entry_point
version.php
version.php in version.php
version2.php
version2.php in version2.php
view_modes.php
view_modes.php in view_modes.php
w
top
word_filter.php
word_filter.php in word_filter.php
warn
FB::warn() in firephp.php
Log object with label to firebug console
warn_exit
warn_exit() in global2.php
This is a less-revealing alternative to fatal_exit, that is used for user-errors/common-corruption-scenarios
warn_exit_wordfilter
warn_exit_wordfilter() in word_filter.php
Exit with a message about word-filtering.
warn_screen
warn_screen() in templates.php
Get the tempcode for a warn page.
will_be_unicode_neutered
Guard for entity_utf8_decode. Checks that the data can be stripped so there is no unicode left. Either the htmlentities function must convert mechanically to entity-characters or all higher ascii character codes (which are actually unicode control codes in a unicode interpretation) that are used happen to be linked to named entities.
wincache
wincache in caches_wincache.php
with_whitespace
with_whitespace() in templates.php
Display some raw text so that it is repeated as raw visually in HTML.
wordfilter_text
wordfilter_text() in support.php
Get a word-filtered version of the specified text.
wrap_probe_ip
wrap_probe_ip() in submit.php
Find a member from their IP address. Unlike plain $GLOBALS['FORUM_DRIVER']->probe_ip, it has the benefit of looking in the adminlogs table also.
write_text_file
write_text_file() in textfiles.php
Write a text file, using the _custom system
x
top
xhtml.php