/code_editor.php

Description
Description | Includes | Functions
Includes
Description | Includes | Functions
require_once ($FILE_BASE.'/'.(array_key_exists('COMPUTERNAME',$_ENV)?$_ENV['COMPUTERNAME']:$_SERVER['SERVER_NAME']).'.php') (line 95)
require_once ($FILE_BASE.'/info.php') (line 96)
Functions
Description | Includes | Functions
ce_sync_file (line 602)

Provides a hook for file synchronisation between mirrored servers.

void ce_sync_file (PATH $filename)
  • PATH $filename: File/directory name to sync on (may be full or relative path)
ce_sync_file_move (line 622)

Provides a hook for file synchronisation between mirrored servers.

void ce_sync_file_move (PATH $old, PATH $new)
  • PATH $old: File/directory name to move from (may be full or relative path)
  • PATH $new: File/directory name to move to (may be full or relative path)
code_editor_do_footer (line 164)

Output the code editors page footer.

void code_editor_do_footer ()
code_editor_do_header (line 125)

Output the code editors page header.

void code_editor_do_header (ID_TEXT $type, [ID_TEXT $target = '_top'])
  • ID_TEXT $type: The type our form clicks are.
  • ID_TEXT $target: The target our form clicks get sent to.
code_editor_do_login (line 177)

Output a login page.

void code_editor_do_login ()
code_editor_escape_html (line 64)

Escape HTML text. Heavily optimised! Ended up with preg_replace after trying lots of things.

  • return: The escaped result.
LONG_TEXT code_editor_escape_html (LONG_TEXT $string)
  • LONG_TEXT $string: The text to escape.
code_editor_fix_permissions (line 318)

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

void code_editor_fix_permissions (PATH $path, [integer $perms = 0666])
  • PATH $path: The full pathname to the file/directory
  • integer $perms: The permissions to make (not the permissions are reduced if the function finds that the file is owned by the web user [doesn't need world permissions then])
convert_to_save_path (line 589)

Convert a normal path to an overriden save path.

  • return: The overridden save path
string convert_to_save_path (string $save_path)
  • string $save_path: The normal path
do_dir (line 242)

Search inside a directory for editable files, whilst favouring the overridden versions.

  • return: A list of the HTML elements for the list box selection.
array do_dir (SHORT_TEXT $dir)
  • SHORT_TEXT $dir: The directory path to search.
do_get_path (line 277)

Output the file selection page.

void do_get_path (SHORT_TEXT $given_password)
  • SHORT_TEXT $given_password: The password previously given to authorise our editing.
do_page (line 384)

Output the editing page and do the editing.

void do_page (SHORT_TEXT $given_password, SHORT_TEXT $path)
  • SHORT_TEXT $given_password: The password previously given to authorise our editing.
  • SHORT_TEXT $path: The path of the file we are editing.
file_get_contents (line 81)

Get the contents of a file.

  • return: The file contents (false: error).
~LONG_TEXT file_get_contents (SHORT_TEXT $filename, [integer $type = 0])
  • SHORT_TEXT $filename: The file name.
  • integer $type: Either FILE_TEXT or FILE_BINARY.
open_up_ftp_connection (line 337)

Open up an FTP connection from POSTed details.

  • return: Either an error screen or a connection. (NULL: not using FTP)
?mixed open_up_ftp_connection ()

Documentation generated on Sun, 02 Jan 2011 23:11:37 +0000 by phpDocumentor 1.4.3