[occle] element index

Package indexes

All elements

top

_array_to_html: virtual_bash::_array_to_html() in occle.php

Convert an array to tempcode for display.
_array_to_text: virtual_bash::_array_to_text() in occle.php

Convert an array to text for display.
_check_is_redirection: virtual_bash::_check_is_redirection() in occle.php

Is the current block a valid redirection instruction?
_combine_streams: virtual_bash::_combine_streams() in occle.php

Combine two streams regardless of their format.
_customise_directory: Hook_root::_customise_directory() in root.php

Customise a directory path, adding _custom to appropriate entries.
_discern_meta_dir: virtual_fs::_discern_meta_dir() in occle.php

Get details of the current meta directory.
_do_indentation: virtual_bash::_do_indentation() in occle.php

Return a specified number of tabs.
_do_where: Hook_database::_do_where() in database.php

Take a provided key-value map from the path and generate a DB query WHERE map array.
_extract_command: virtual_bash::_extract_command() in occle.php

Extract the command name from the input.
_extract_extras: virtual_bash::_extract_extras() in occle.php

Extract extra tokens from the input.
_extract_options: virtual_bash::_extract_options() in occle.php

Extract options (switches) from the input.
_extract_parameters: virtual_bash::_extract_parameters() in occle.php

Extract parameters from the input.
_find_script_file: virtual_bash::_find_script_file() in occle.php

Find a script file.
_get_current_dir_contents: virtual_fs::_get_current_dir_contents() in occle.php

Return the contents of the given directory in $this->virtual_fs (i.e. ls without the fancy bits).
_get_filename: virtual_fs::_get_filename() in occle.php

Return filename from a path.
_handle_php_command: virtual_bash::_handle_php_command() in occle.php

Handle a PHP command by executing it, dealing with variables from the class.
_is_dir: virtual_fs::_is_dir() in occle.php

Is it a directory?
_is_file: virtual_fs::_is_file() in occle.php

Is it a file?
_merge_pwds: virtual_fs::_merge_pwds() in occle.php

Merge an absolute array-form path with a non-absolute array-form path.
_pwd_to_array: virtual_fs::_pwd_to_array() in occle.php

Convert a string-form path to an array.
_pwd_to_string: virtual_fs::_pwd_to_string() in occle.php

Convert an array-form path to a string.
_start_pwd: virtual_fs::_start_pwd() in occle.php

Fetch the current directory from a cookie, or the default.

top

admin_occle.php: admin_occle.php in admin_occle.php
append_file: virtual_fs::append_file() in occle.php

Append to a file.
append.php: append.php in append.php

top

ban_ip.php: ban_ip.php in ban_ip.php
ban_member.php: ban_member.php in ban_member.php
bsod.php: bsod.php in bsod.php
bin.php: bin.php in bin.php
bottom_show_occle_button.php: bottom_show_occle_button.php in bottom_show_occle_button.php

top

$current_input: virtual_bash::$current_input in occle.php
change_directory: virtual_fs::change_directory() in occle.php

Change the current working directory. Equivalent to Unix "cd".
copy_directory: virtual_fs::copy_directory() in occle.php

Copy a directory. Equivalent to Unix "cp".
copy_file: virtual_fs::copy_file() in occle.php

Copy a file. Equivalent to Unix "cp".
call.php: call.php in call.php
cat.php: cat.php in cat.php
cd.php: cd.php in cd.php
clear.php: clear.php in clear.php
clear_caches.php: clear_caches.php in clear_caches.php
closed.php: closed.php in closed.php
commands.php: commands.php in commands.php
cp.php: cp.php in cp.php
cpdir.php: cpdir.php in cpdir.php

top

do_command_help: do_command_help() in occle.php

Template for a command's help.
date.php: date.php in date.php
database.php: database.php in database.php

top

escape_name: Hook_database::escape_name() in database.php

Escape a value for use in a filesystem path.
echo.php: echo.php in echo.php
edit.php: edit.php in edit.php
exit.php: exit.php in exit.php
etc.php: etc.php in etc.php

top

$fs: virtual_bash::$fs in occle.php
feedback.php: feedback.php in feedback.php
find.php: find.php in find.php
find_codes.php: find_codes.php in find_codes.php
find_entry_points.php: find_entry_points.php in find_entry_points.php
find_function.php: find_function.php in find_function.php
fix_perms.php: fix_perms.php in fix_perms.php

top

get_chmod_array: Hook_addon_registry_occle::get_chmod_array() in occle.php

Get a list of file permissions to set
get_default: Hook_config_default_occle_chat_announce::get_default() in occle_chat_announce.php

Gets the default value for the config option.
get_default: Hook_config_default_bottom_show_occle_button::get_default() in bottom_show_occle_button.php

Gets the default value for the config option.
get_dependencies: Hook_addon_registry_occle::get_dependencies() in occle.php

Get a mapping of dependency types
get_description: Hook_addon_registry_occle::get_description() in occle.php

Get the description of the addon
get_details: Hook_config_default_bottom_show_occle_button::get_details() in bottom_show_occle_button.php

Gets the details relating to the config option.
get_details: Hook_config_default_occle_chat_announce::get_details() in occle_chat_announce.php

Gets the details relating to the config option.
get_entry_points: Module_admin_occle::get_entry_points() in admin_occle.php

Standard modular entry-point finder function.
get_file_list: Hook_addon_registry_occle::get_file_list() in occle.php

Get a list of files that belong to this addon
get_queued_messages: get_queued_messages() in occle.php

Returns a string containing the XML for any messages queued to be sent to the client.
get_version: Hook_addon_registry_occle::get_version() in occle.php

Get the version of ocPortal this addon is for
grep.php: grep.php in grep.php

top

Hook_addon_registry_occle: Hook_addon_registry_occle in occle.php
Hook_append: Hook_append in append.php
Hook_ban_ip: Hook_ban_ip in ban_ip.php
Hook_ban_member: Hook_ban_member in ban_member.php
Hook_bin: Hook_bin in bin.php
Hook_bsod: Hook_bsod in bsod.php
Hook_call: Hook_call in call.php
Hook_cat: Hook_cat in cat.php
Hook_cd: Hook_cd in cd.php
Hook_clear: Hook_clear in clear.php
Hook_clear_caches: Hook_clear_caches in clear_caches.php
Hook_closed: Hook_closed in closed.php
Hook_commands: Hook_commands in commands.php
Hook_config_default_bottom_show_occle_button: Hook_config_default_bottom_show_occle_button in bottom_show_occle_button.php
Hook_config_default_occle_chat_announce: Hook_config_default_occle_chat_announce in occle_chat_announce.php
Hook_cp: Hook_cp in cp.php
Hook_cpdir: Hook_cpdir in cpdir.php
Hook_database: Hook_database in database.php
Hook_date: Hook_date in date.php
Hook_do_next_menus_occle: Hook_do_next_menus_occle in occle.php
Hook_echo: Hook_echo in echo.php
Hook_edit: Hook_edit in edit.php
Hook_etc: Hook_etc in etc.php
Hook_exit: Hook_exit in exit.php
Hook_feedback: Hook_feedback in feedback.php
Hook_find: Hook_find in find.php
Hook_find_codes: Hook_find_codes in find_codes.php
Hook_find_entry_points: Hook_find_entry_points in find_entry_points.php
Hook_find_function: Hook_find_function in find_function.php
Hook_fix_perms: Hook_fix_perms in fix_perms.php
Hook_grep: Hook_grep in grep.php
Hook_help: Hook_help in help.php
Hook_ls: Hook_ls in ls.php
Hook_mkdir: Hook_mkdir in mkdir.php
Hook_mv: Hook_mv in mv.php
Hook_mvdir: Hook_mvdir in mvdir.php
Hook_Notification_occlechat: Hook_Notification_occlechat in occlechat.php
Hook_Notification_unvalidated: Hook_Notification_unvalidated in unvalidated.php
Hook_occle: Hook_occle in occle.php
Hook_occlechat: Hook_occlechat in occlechat.php
Hook_passwd: Hook_passwd in passwd.php
Hook_pwd: Hook_pwd in pwd.php
Hook_raw: Hook_raw in raw.php
Hook_read: Hook_read in read.php
Hook_reset: Hook_reset in reset.php
Hook_rm: Hook_rm in rm.php
Hook_rmdir: Hook_rmdir in rmdir.php
Hook_root: Hook_root in root.php
Hook_time: Hook_time in time.php
Hook_users_online: Hook_users_online in users_online.php
Hook_version: Hook_version in version.php
Hook_whoami: Hook_whoami in whoami.php
Hook_whois: Hook_whois in whois.php
Hook_write: Hook_write in write.php
help.php: help.php in help.php

top

$input_parameters: virtual_bash::$input_parameters in occle.php
info: Module_admin_occle::info() in admin_occle.php

Standard modular info function.
init__occle: init__occle() in occle.php

Standard code module initialisation function.
install: Module_admin_occle::install() in admin_occle.php

Standard modular install function.

top

listing: virtual_fs::listing() in occle.php

Return a directory and file listing of the current working directory. Equivalent to Unix "ls".
listing: Hook_raw::listing() in raw.php

Standard modular listing function for OcCLE FS hooks.
listing: Hook_bin::listing() in bin.php

Standard modular listing function for OcCLE FS hooks.
listing: Hook_etc::listing() in etc.php

Standard modular listing function for OcCLE FS hooks.
listing: Hook_database::listing() in database.php

Standard modular listing function for OcCLE FS hooks.
listing: Hook_root::listing() in root.php

Standard modular listing function for OcCLE FS hooks.
ls.php: ls.php in ls.php

top

main_gui: Module_admin_occle::main_gui() in admin_occle.php

The main OcCLE GUI.
make_directory: virtual_fs::make_directory() in occle.php

Create a directory under the current working directory. Equivalent to Unix "mkdir".
make_directory: Hook_raw::make_directory() in raw.php

Standard modular directory creation function for OcCLE FS hooks.
make_directory: Hook_etc::make_directory() in etc.php

Standard modular directory creation function for OcCLE FS hooks.
make_directory: Hook_database::make_directory() in database.php

Standard modular directory creation function for OcCLE FS hooks.
make_directory: Hook_bin::make_directory() in bin.php

Standard modular directory creation function for OcCLE FS hooks.
make_directory: Hook_root::make_directory() in root.php

Standard modular directory creation function for OcCLE FS hooks.
make_functions_dat: make_functions_dat() in find_function.php

Make the functions.dat file
make_functions_dat_do_dir: make_functions_dat_do_dir() in find_function.php

Scan a directory for PHP files.
Module_admin_occle: Module_admin_occle in admin_occle.php

Module page class.
move_directory: virtual_fs::move_directory() in occle.php

Move a directory. Equivalent to Unix "mv".
move_file: virtual_fs::move_file() in occle.php

Move a file. Equivalent to Unix "mv".
mkdir.php: mkdir.php in mkdir.php
mv.php: mv.php in mv.php
mvdir.php: mvdir.php in mvdir.php

top

$output: virtual_bash::$output in occle.php
occle.php: occle.php in occle.php
occle_make_normal_html_visible: occle_make_normal_html_visible() in occle.php

Put something non-OcCLE in a standard box so it looks OK.
occle_script: occle_script() in occle.php

OcCLE entry script.
output_html: virtual_bash::output_html() in occle.php

Return the HTML rendering of the parsed command's output.
output_xml: virtual_bash::output_xml() in occle.php

Output an XML-RPC packet (hopefully) to the AJAX in the frontend.
occlechat.php: occlechat.php in occlechat.php
occlechat.php: occlechat.php in occlechat.php
occle.php: occle.php in occle.php
occle_chat_announce.php: occle_chat_announce.php in occle_chat_announce.php
occle.php: occle.php in occle.php
occle.php: occle.php in occle.php
occle.php: occle.php in occle.php

top

$parsed_input: virtual_bash::$parsed_input in occle.php
$parse_runtime: virtual_bash::$parse_runtime in occle.php
parse_input: virtual_bash::parse_input() in occle.php

Parses input setup in constructor, and creates a parse tree.
print_working_directory: virtual_fs::print_working_directory() in occle.php

Return the current working directory of the virtual filesystem. Equivalent to Unix "pwd".
passwd.php: passwd.php in passwd.php
pwd.php: pwd.php in pwd.php

top

read_file: Hook_database::read_file() in database.php

Standard modular file reading function for OcCLE FS hooks.
read_file: Hook_root::read_file() in root.php

Standard modular file reading function for OcCLE FS hooks.
read_file: Hook_etc::read_file() in etc.php

Standard modular file reading function for OcCLE FS hooks.
read_file: Hook_bin::read_file() in bin.php

Standard modular file reading function for OcCLE FS hooks.
read_file: virtual_fs::read_file() in occle.php

Read a file and return the contents.
read_file: Hook_raw::read_file() in raw.php

Standard modular file reading function for OcCLE FS hooks.
remove_directory: Hook_etc::remove_directory() in etc.php

Standard modular directory removal function for OcCLE FS hooks.
remove_directory: virtual_fs::remove_directory() in occle.php

Remove a directory under the current working directory. Equivalent to Unix "rmdir".
remove_directory: Hook_raw::remove_directory() in raw.php

Standard modular directory removal function for OcCLE FS hooks.
remove_directory: Hook_root::remove_directory() in root.php

Standard modular directory removal function for OcCLE FS hooks.
remove_directory: Hook_database::remove_directory() in database.php

Standard modular directory removal function for OcCLE FS hooks.
remove_directory: Hook_bin::remove_directory() in bin.php

Standard modular directory removal function for OcCLE FS hooks.
remove_file: Hook_raw::remove_file() in raw.php

Standard modular file removal function for OcCLE FS hooks.
remove_file: Hook_bin::remove_file() in bin.php

Standard modular file removal function for OcCLE FS hooks.
remove_file: Hook_etc::remove_file() in etc.php

Standard modular file removal function for OcCLE FS hooks.
remove_file: virtual_fs::remove_file() in occle.php

Remove a file. Equivalent to Unix "rm".
remove_file: Hook_database::remove_file() in database.php

Standard modular file removal function for OcCLE FS hooks.
remove_file: Hook_root::remove_file() in root.php

Standard modular file removal function for OcCLE FS hooks.
return_output: virtual_bash::return_output() in occle.php

Returns the output for the command just parsed.
return_parse_tree: virtual_bash::return_parse_tree() in occle.php

Returns the parse tree for the command just parsed.
run: Hook_occlechat::run() in occlechat.php

Standard modular run function for OcCLE hooks.
run: Hook_Notification_occlechat::run() in occlechat.php

Standard modular run function for OcCLE notification hooks.
run: Hook_Notification_unvalidated::run() in unvalidated.php

Standard modular run function for OcCLE notification hooks.
run: Hook_write::run() in write.php

Standard modular run function for OcCLE hooks.
run: Hook_do_next_menus_occle::run() in occle.php

Standard modular run function for do_next_menu hooks. They find links to put on standard navigation menus of the system.
run: Hook_passwd::run() in passwd.php

Standard modular run function for OcCLE hooks.
run: Hook_whois::run() in whois.php

Standard modular run function for OcCLE hooks.
run: Hook_pwd::run() in pwd.php

Standard modular run function for OcCLE hooks.
run: Hook_reset::run() in reset.php

Standard modular run function for OcCLE hooks.
run: Hook_read::run() in read.php

Standard modular run function for OcCLE hooks.
run: Hook_users_online::run() in users_online.php

Standard modular run function for OcCLE hooks.
run: Hook_version::run() in version.php

Standard modular run function for OcCLE hooks.
run: Hook_rm::run() in rm.php

Standard modular run function for OcCLE hooks.
run: Hook_whoami::run() in whoami.php

Standard modular run function for OcCLE hooks.
run: Hook_rmdir::run() in rmdir.php

Standard modular run function for OcCLE hooks.
run: Hook_time::run() in time.php

Standard modular run function for OcCLE hooks.
run: Hook_occle::run() in occle.php

Standard modular run function for snippet hooks. Generates XHTML to insert into a page using AJAX.
run: Hook_mkdir::run() in mkdir.php

Standard modular run function for OcCLE hooks.
run: Hook_closed::run() in closed.php

Standard modular run function for OcCLE hooks.
run: Hook_clear_caches::run() in clear_caches.php

Standard modular run function for OcCLE hooks.
run: Hook_commands::run() in commands.php

Standard modular run function for OcCLE hooks.
run: Hook_cp::run() in cp.php

Standard modular run function for OcCLE hooks.
run: Hook_mvdir::run() in mvdir.php

Standard modular run function for OcCLE hooks.
run: Hook_cpdir::run() in cpdir.php

Standard modular run function for OcCLE hooks.
run: Hook_clear::run() in clear.php

Standard modular run function for OcCLE hooks.
run: Hook_cd::run() in cd.php

Standard modular run function for OcCLE hooks.
run: Hook_ban_ip::run() in ban_ip.php

Standard modular run function for OcCLE hooks.
run: Hook_append::run() in append.php

Standard modular run function for OcCLE hooks.
run: Hook_ban_member::run() in ban_member.php

Standard modular run function for OcCLE hooks.
run: Hook_bsod::run() in bsod.php

Standard modular run function for OcCLE hooks.
run: Hook_cat::run() in cat.php

Standard modular run function for OcCLE hooks.
run: Hook_call::run() in call.php

Standard modular run function for OcCLE hooks.
run: Hook_echo::run() in echo.php

Standard modular run function for OcCLE hooks.
run: Hook_date::run() in date.php

Standard modular run function for OcCLE hooks.
run: Hook_fix_perms::run() in fix_perms.php

Standard modular run function for OcCLE hooks.
run: Hook_find_function::run() in find_function.php

Standard modular run function for OcCLE hooks.
run: Hook_find_entry_points::run() in find_entry_points.php

Standard modular run function for OcCLE hooks.
run: Hook_grep::run() in grep.php

Standard modular run function for OcCLE hooks.
run: Hook_help::run() in help.php

Standard modular run function for OcCLE hooks.
run: Hook_mv::run() in mv.php

Standard modular run function for OcCLE hooks.
run: Module_admin_occle::run() in admin_occle.php

Standard modular run function.
run: Hook_ls::run() in ls.php

Standard modular run function for OcCLE hooks.
run: Hook_find_codes::run() in find_codes.php

Standard modular run function for OcCLE hooks.
run: Hook_find::run() in find.php

Standard modular run function for OcCLE hooks.
run: Hook_exit::run() in exit.php

Standard modular run function for OcCLE hooks.
run: Hook_feedback::run() in feedback.php

Standard modular run function for OcCLE hooks.
run: Hook_edit::run() in edit.php

Standard modular run function for OcCLE hooks.
read.php: read.php in read.php
reset.php: reset.php in reset.php
rm.php: rm.php in rm.php
rmdir.php: rmdir.php in rmdir.php
raw.php: raw.php in raw.php
root.php: root.php in root.php

top

search: virtual_fs::search() in occle.php

Return a listing of all the files/directories found matching the specified pattern. Equivalent to Unix "find".

top

time.php: time.php in time.php
tpl_previews: Hook_addon_registry_occle::tpl_previews() in occle.php

Get mapping between template names and the method of this class that can render a preview of them
tpl_preview__administrative__occle_array: Hook_addon_registry_occle::tpl_preview__administrative__occle_array() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_box: Hook_addon_registry_occle::tpl_preview__administrative__occle_box() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_chat_notification: Hook_addon_registry_occle::tpl_preview__administrative__occle_chat_notification() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_command: Hook_addon_registry_occle::tpl_preview__administrative__occle_command() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_commands: Hook_addon_registry_occle::tpl_preview__administrative__occle_commands() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_edit: Hook_addon_registry_occle::tpl_preview__administrative__occle_edit() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_entry_points: Hook_addon_registry_occle::tpl_preview__administrative__occle_entry_points() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_find_codes: Hook_addon_registry_occle::tpl_preview__administrative__occle_find_codes() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_help: Hook_addon_registry_occle::tpl_preview__administrative__occle_help() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_ls: Hook_addon_registry_occle::tpl_preview__administrative__occle_ls() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_main: Hook_addon_registry_occle::tpl_preview__administrative__occle_main() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_main_screen: Hook_addon_registry_occle::tpl_preview__administrative__occle_main_screen() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_occlechat_notification: Hook_addon_registry_occle::tpl_preview__administrative__occle_occlechat_notification() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_ocf_notification: Hook_addon_registry_occle::tpl_preview__administrative__occle_ocf_notification() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_rss: Hook_addon_registry_occle::tpl_preview__administrative__occle_rss() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_unvalidated_notification: Hook_addon_registry_occle::tpl_preview__administrative__occle_unvalidated_notification() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_users_online: Hook_addon_registry_occle::tpl_preview__administrative__occle_users_online() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.
tpl_preview__administrative__occle_whois: Hook_addon_registry_occle::tpl_preview__administrative__occle_whois() in occle.php

Get a preview(s) of a (group of) template(s), as a full standalone piece of HTML in Tempcode format.

top

users_online.php: users_online.php in users_online.php
unvalidated.php: unvalidated.php in unvalidated.php
unescape_name: Hook_database::unescape_name() in database.php

Unescape a value from a filesystem path back to the original.
uninstall: Module_admin_occle::uninstall() in admin_occle.php

Standard modular uninstall function.

top

version.php: version.php in version.php
virtual_bash: virtual_bash in occle.php
virtual_bash: virtual_bash::virtual_bash() in occle.php

Constructor function. Starts command parsing on the supplied command.
virtual_fs: virtual_fs in occle.php
virtual_fs: virtual_fs::virtual_fs() in occle.php

Constructor function. Setup a virtual filesystem, but do nothing with it.

top

whoami.php: whoami.php in whoami.php
whois.php: whois.php in whois.php
write.php: write.php in write.php
write_file: Hook_root::write_file() in root.php

Standard modular file writing function for OcCLE FS hooks.
write_file: Hook_raw::write_file() in raw.php

Standard modular file writing function for OcCLE FS hooks.
write_file: Hook_database::write_file() in database.php

Standard modular file writing function for OcCLE FS hooks.
write_file: Hook_etc::write_file() in etc.php

Standard modular file writing function for OcCLE FS hooks.
write_file: virtual_fs::write_file() in occle.php

Write to a file; create the file if it doesn't exist.
write_file: Hook_bin::write_file() in bin.php

Standard modular file writing function for OcCLE FS hooks.