Class Hook_database

Description

Located in /sources/hooks/modules/admin_occle_fs/database.php (line 21)


	
			
Method Summary
string escape_name (string $in)
~array listing (array $meta_dir, string $meta_root_node, array $current_dir, array &$occle_fs)
boolean make_directory (array $meta_dir, string $meta_root_node, string $new_dir_name, array &$occle_fs)
~string read_file (array $meta_dir, string $meta_root_node, string $file_name, array &$occle_fs)
boolean remove_directory (array $meta_dir, string $meta_root_node, string $dir_name, array &$occle_fs)
boolean remove_file (array $meta_dir, string $meta_root_node, string $file_name, array &$occle_fs)
string unescape_name (string $in)
boolean write_file (array $meta_dir, string $meta_root_node, string $file_name, mixed $contents, array &$occle_fs)
~array _do_where (string $table_name, string $keys)
Methods
escape_name (line 319)

Escape a value for use in a filesystem path.

  • return: Escaped value
string escape_name (string $in)
  • string $in: Value to escape (original value)
listing (line 32)

Standard modular listing function for OcCLE FS hooks.

  • return: The final directory listing (false: failure)
~array listing (array $meta_dir, string $meta_root_node, array $current_dir, array &$occle_fs)
  • array $meta_dir: The current meta-directory path
  • string $meta_root_node: The root node of the current meta-directory
  • array $current_dir: The current directory listing
  • array &$occle_fs: A reference to the OcCLE filesystem object
make_directory (line 103)

Standard modular directory creation function for OcCLE FS hooks.

  • return: Success?
boolean make_directory (array $meta_dir, string $meta_root_node, string $new_dir_name, array &$occle_fs)
  • array $meta_dir: The current meta-directory path
  • string $meta_root_node: The root node of the current meta-directory
  • string $new_dir_name: The new directory name
  • array &$occle_fs: A reference to the OcCLE filesystem object
read_file (line 212)

Standard modular file reading function for OcCLE FS hooks.

  • return: The file contents (false: failure)
~string read_file (array $meta_dir, string $meta_root_node, string $file_name, array &$occle_fs)
  • array $meta_dir: The current meta-directory path
  • string $meta_root_node: The root node of the current meta-directory
  • string $file_name: The file name
  • array &$occle_fs: A reference to the OcCLE filesystem object
remove_directory (line 150)

Standard modular directory removal function for OcCLE FS hooks.

  • return: Success?
boolean remove_directory (array $meta_dir, string $meta_root_node, string $dir_name, array &$occle_fs)
  • array $meta_dir: The current meta-directory path
  • string $meta_root_node: The root node of the current meta-directory
  • string $dir_name: The directory name
  • array &$occle_fs: A reference to the OcCLE filesystem object
remove_file (line 177)

Standard modular file removal function for OcCLE FS hooks.

  • return: Success?
boolean remove_file (array $meta_dir, string $meta_root_node, string $file_name, array &$occle_fs)
  • array $meta_dir: The current meta-directory path
  • string $meta_root_node: The root node of the current meta-directory
  • string $file_name: The file name
  • array &$occle_fs: A reference to the OcCLE filesystem object
unescape_name (line 330)

Unescape a value from a filesystem path back to the original.

  • return: Original value
string unescape_name (string $in)
  • string $in: Escaped value
write_file (line 239)

Standard modular file writing function for OcCLE FS hooks.

  • return: Success?
boolean write_file (array $meta_dir, string $meta_root_node, string $file_name, mixed $contents, array &$occle_fs)
  • array $meta_dir: The current meta-directory path
  • string $meta_root_node: The root node of the current meta-directory
  • string $file_name: The file name
  • mixed $contents: The new file contents (string or integer)
  • array &$occle_fs: A reference to the OcCLE filesystem object
_do_where (line 279)

Take a provided key-value map from the path and generate a DB query WHERE map array.

  • return: WHERE map array (false: if an invalid key was referenced)
~array _do_where (string $table_name, string $keys)
  • string $table_name: Database table name
  • string $keys: Key-value map ("key:value,key2:value2")

Documentation generated on Sun, 02 Jan 2011 23:12:48 +0000 by phpDocumentor 1.4.3