Class Hook_raw

Description

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


	
			
Method Summary
~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)
boolean write_file (array $meta_dir, string $meta_root_node, string $file_name, string $contents, array &$occle_fs)
Methods
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 64)

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 148)

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 92)

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 121)

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
write_file (line 174)

Standard modular file writing function for OcCLE FS hooks.

  • return: Success?
boolean write_file (array $meta_dir, string $meta_root_node, string $file_name, string $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
  • string $contents: The new file contents
  • array &$occle_fs: A reference to the OcCLE filesystem object

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