phpDocumentor epesi-utils
attachment
[ class tree: epesi-utils ] [ index: epesi-utils ] [ all elements ]

Class: Utils_Attachment

Source Location: /modules/Utils/Attachment/Attachment_0.php

Class Utils_Attachment

Class Overview

Use this module if you want to add attachments to some page.

Owner of note has always 3x(private,protected,public) write&read. Permission for group is set by methods allow_{private,protected,public}.

Located in /modules/Utils/Attachment/Attachment_0.php [line 16]

ModuleAcl
   |
   --ModulePrimitive
      |
      --Module
         |
         --Utils_Attachment
Author(s): Information Tags:
Version:  1.0
Copyright:  Copyright © 2008, Telaxus LLC
License:  MIT

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Module

Module::$children
Module::$display_func
Module::$parent

Inherited From Module

Module::__construct()
Constructor. Should not be called directly using new Module('name').
Module::call_callback_href()
Module::clear_module_variables()
Unset all module variables.
Module::create_back_href()
Creates link that will lead back to previous page content.
Module::create_back_href_js()
Module::create_callback_href()
Creates link similar to link created with create_href.
Module::create_callback_href_js()
Creates link similar to link created with create_href.
Module::create_callback_href_with_id()
Creates link similar to links created with create_href.
Module::create_callback_href_with_id_js()
Creates link similar to links created with create_href.
Module::create_confirm_callback_href()
Creates link similar to link created with create_href.
Module::create_confirm_callback_href_with_id()
Creates link similar to links created with create_href.
Module::create_confirm_href()
Create onClick action string (with href="javascript:void(0);").
Module::create_confirm_unique_href()
Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
Module::create_href()
Create onClick action string (with href="javascript:void(0);").
Module::create_href_js()
Create onClick action string destined for js code.
Module::create_unique_href()
Similar to create_href, but variables passed to this function will only be accessible in module that called this function.
Module::create_unique_href_js()
Create onClick action string destined for js code.
Module::create_unique_key()
Returns unique key name, generated from unique name of this module (function get_path) and string parameter.
Module::displayed()
Returns whether this module instance was already displayed.
Module::display_module()
Call method of the module passed as first parameter, which name is passed as second parameter.
Module::freeze_module()
Makes child module to not loose its module variables
Module::get_child()
Gets child module with specified node id.
Module::get_children()
Gets array of children modules.
Module::get_html_of_module()
Call method of the module passed as first parameter, which name is passed as second parameter.
Module::get_instance_id()
Returns id of module instance.
Module::get_jses()
Returns list of jses to evaluate.
Module::get_module_variable()
Returns value of a module variable. If the variable is not set, function will return value given as second parameter.
Module::get_module_variable_or_unique_href_variable()
Returns href variable.
Module::get_node_id()
Get node identifier.
Module::get_parent_path()
Returns unique path of parent module.
Module::get_parent_type()
Returns name(type) of parent module.
Module::get_path()
Returns unique path of calling module.
Module::get_reload()
Returns current reload settings.
Module::get_unique_href_variable()
Returns variable passed with create_unique_href.
Module::init_module()
Creates module instance which name is given as first parameter.
Module::isset_module_variable()
Checks if variable exists.
Module::isset_unique_href_variable()
Checks if variable given as first parameter was passed with create_unique_href function.
Module::is_back()
Checks if set_back_location was used.
Module::is_fast_process()
Returns whether this module instance has fast processing turned on.
Module::is_inline_display()
Returns whether this module instance is displayed inline.
Module::js()
Appends js code to list of jses to evaluate.
Module::mark_displayed()
Marks this module instance as it was displayed.
Module::pack_module()
Creates instance of module given as first parameter as a child of the module that has called this function.
Module::register_method()
Module::set_back_location()
Sets reload location to previous page display.
Module::set_fast_process()
Enable fast processing for this module instance.
Module::set_inline_display()
Changes display behavior for this module instance to inline.
Module::set_module_variable()
Sets variable that will be available only for module instance that called this function.
Module::set_reload()
Mark module to force its reload or prevent being reloaded.
Module::share_module_variable()
Share variable passed as first parameter with module passed as second parameter.
Module::share_unique_href_variable()
Share href variable passed as first parameter with module passed as second parameter.
Module::static_get_module_variable()
Returns value of a module variable. If the variable is not set, function will return value given as third parameter.
Module::static_isset_module_variable()
Checks if variable exists.
Module::static_set_module_variable()
Sets variable that will be available only for module instance that called this function.
Module::static_unset_module_variable()
Module::unset_module_variable()
Unset module variable.
Module::unset_unique_href_variable()
Unsets *unique_href variable.
Module::__call()

Inherited From ModulePrimitive

ModulePrimitive::__construct()
ModulePrimitive::check_access()
Checks access to function which name is passed as first parameter.
ModulePrimitive::create_data_dir()
Creates default data directory for module. Typical usage: in module installation
ModulePrimitive::get_data_dir()
Returns path to the default data directory for module calling this method.
ModulePrimitive::get_module_dir()
Returns path to the module directory.
ModulePrimitive::get_type()
Returns name(type) of module that called this function.
ModulePrimitive::get_type_with_bt()
ModulePrimitive::remove_data_dir()
Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()
ModuleAcl::add_aco()
ModuleAcl::del_aco()
ModuleAcl::get_type()

[ Top ]
Method Summary
void   additional_header()  
void   allow_private()  
void   allow_protected()  
void   allow_public()  
void   body()  
void   caption()  
void   construct()  
void   delete()  
void   delete_back()  
void   display_author_column()  
void   edition_history()  
void   edition_history_queue()  
void   edit_note()  
void   edit_note_queue()  
void   enable_watchdog()  
void   get_file()  
void   inline_attach_file()  
void   pop_box0()  
void   push_box0()  
void   restore_file()  
void   restore_note()  
void   set_persistent_delete()  
void   set_view_func()  
void   submit_attach()  
void   submit_edit()  
void   view()  
void   view_queue()  

[ Top ]
Methods
additional_header  [line 58]

  void additional_header( $x  )

Parameters:
   $x: 

API Tags:
Access:  public


[ Top ]
allow_private  [line 75]

  void allow_private( $read, [ $write = null]  )

Parameters:
   $read: 
   $write: 

API Tags:
Access:  public


[ Top ]
allow_protected  [line 81]

  void allow_protected( $read, [ $write = null]  )

Parameters:
   $read: 
   $write: 

API Tags:
Access:  public


[ Top ]
allow_public  [line 87]

  void allow_public( $read, [ $write = null]  )

Parameters:
   $read: 
   $write: 

API Tags:
Access:  public


[ Top ]
body  [line 97]

  void body( )


API Tags:
Access:  public


[ Top ]
caption  [line 604]

  void caption( )


API Tags:
Access:  public


[ Top ]
construct  [line 39]

  void construct( $group, [ $pd = null], [ $in = null], [ $priv_r = null], [ $priv_w = null], [ $prot_r = null], [ $prot_w = null], [ $pub_r = null], [ $pub_w = null], [ $header = null], [ $watchdog_cat = null], [ $watchdog_id = null], [ $func = null], [ $args = null]  )

Parameters:
   $group: 
   $pd: 
   $in: 
   $priv_r: 
   $priv_w: 
   $prot_r: 
   $prot_w: 
   $pub_r: 
   $pub_w: 
   $header: 
   $watchdog_cat: 
   $watchdog_id: 
   $func: 
   $args: 

API Tags:
Access:  public


[ Top ]
delete  [line 589]

  void delete( $id  )

Parameters:
   $id: 

API Tags:
Access:  public


[ Top ]
delete_back  [line 353]

  void delete_back( $id  )

Parameters:
   $id: 

API Tags:
Access:  public


[ Top ]
display_author_column  [line 93]

  void display_author_column( [ $x = true]  )

Parameters:
   $x: 

API Tags:
Access:  public


[ Top ]
edition_history  [line 363]

  void edition_history( $id  )

Parameters:
   $id: 

API Tags:
Access:  public


[ Top ]
edition_history_queue  [line 359]

  void edition_history_queue( $id  )

Parameters:
   $id: 

API Tags:
Access:  public


[ Top ]
edit_note  [line 496]

  void edit_note( [ $id = null]  )

Parameters:
   $id: 

API Tags:
Access:  public


[ Top ]
edit_note_queue  [line 492]

  void edit_note_queue( [ $id = null]  )

Parameters:
   $id: 

API Tags:
Access:  public


[ Top ]
enable_watchdog  [line 608]

  void enable_watchdog( $category, $id  )

Parameters:
   $category: 
   $id: 

API Tags:
Access:  public


[ Top ]
get_file  [line 255]

  void get_file( $row, [ &$view_link = '']  )

Parameters:
   $row: 
   &$view_link: 

API Tags:
Access:  public


[ Top ]
inline_attach_file  [line 67]

  void inline_attach_file( [ $x = true]  )

Parameters:
   $x: 

API Tags:
Access:  public


[ Top ]
pop_box0  [line 480]

  void pop_box0( )


API Tags:
Access:  public


[ Top ]
push_box0  [line 486]

  void push_box0( $func, $args, $const_args  )

Parameters:
   $func: 
   $args: 
   $const_args: 

API Tags:
Access:  public


[ Top ]
restore_file  [line 469]

  void restore_file( $id, $rev  )

Parameters:
   $id: 
   $rev: 

API Tags:
Access:  public


[ Top ]
restore_note  [line 461]

  void restore_note( $id, $rev  )

Parameters:
   $id: 
   $rev: 

API Tags:
Access:  public


[ Top ]
set_persistent_delete  [line 71]

  void set_persistent_delete( [ $x = true]  )

Parameters:
   $x: 

API Tags:
Access:  public


[ Top ]
set_view_func  [line 62]

  void set_view_func( $x, [ $y = array()]  )

Parameters:
   $x: 
array   $y: 

API Tags:
Access:  public


[ Top ]
submit_attach  [line 549]

  void submit_attach( $file, $oryg, $data  )

Parameters:
   $file: 
   $oryg: 
   $data: 

API Tags:
Access:  public


[ Top ]
submit_edit  [line 565]

  void submit_edit( $file, $oryg, $data, $id, $text  )

Parameters:
   $file: 
   $oryg: 
   $data: 
   $id: 
   $text: 

API Tags:
Access:  public


[ Top ]
view  [line 287]

  void view( $id  )

Parameters:
   $id: 

API Tags:
Access:  public


[ Top ]
view_queue  [line 251]

  void view_queue( $id  )

Parameters:
   $id: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:38:21 -0500 by phpDocumentor 1.4.2