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

Class: Utils_Comment

Source Location: /modules/Utils/Comment/Comment_0.php

Class Utils_Comment

Class Overview

Located in /modules/Utils/Comment/Comment_0.php [line 12]

ModuleAcl
   |
   --ModulePrimitive
      |
      --Module
         |
         --Utils_Comment
Author(s): Information Tags:
Version:  1.0
Copyright:  Copyright © 2006, 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   add_post()   Adds new comment to current comment group.
void   body()   Displays Comments.
void   construct()   Constructs new instance of Comment module.
array   fetch_posts()   Returns all comments from current (specified during construction) comment group.
void   post_reply()   Displays and processes post replying form.
void   reply_on_comment_page()   Sets what method of posting comments should be used.
void   set_moderator()   Sets whether moderation options are available.
void   set_per_page()   Sets how many comments should be displayed on the page.
void   set_reply()   Sets whether user is allowed to reply.
void   tree_structure()   Sets whether replying to specific comment is allowed.

[ Top ]
Methods
add_post  [line 245]

  void add_post( string $post_text, [integer $answer_to = -1]  )

Adds new comment to current comment group.

You can also specify to which comment this was reply to.

Parameters:
string   $post_text:  text message
integer   $answer_to:  id of a comment to which this one replies

API Tags:
Access:  public


[ Top ]
body  [line 37]

  void body( )

Displays Comments.


API Tags:
Access:  public


[ Top ]
construct  [line 29]

  void construct( string $key  )

Constructs new instance of Comment module.

Key specifies group of comments that will be operated with this instance.

Parameters:
string   $key:  identifier of the comment group

API Tags:
Access:  public


[ Top ]
fetch_posts  [line 153]

  array fetch_posts( )

Returns all comments from current (specified during construction) comment group.

The result is an array. Each field in this array represents one comment. Comment is described with an array with following fields: text - comment contents user - username of a user that posted this comment date - date when comment was posted in format 'G:i, d M Y' report - link that allows to report this comment delete - link that allows to delete this comment reply - link that will switch 'reply to' to this comment tabs - number of tabs that are used to represent comment replies


API Tags:
Return:  all comments
Access:  public


[ Top ]
post_reply  [line 200]

  void post_reply( )

Displays and processes post replying form.


API Tags:
Access:  public


[ Top ]
reply_on_comment_page  [line 314]

  void reply_on_comment_page( bool $rocp  )

Sets what method of posting comments should be used.

True by default.

Parameters:
bool   $rocp:  true to reply on comment page, false to place button on ActionBar

API Tags:
Access:  public


[ Top ]
set_moderator  [line 284]

  void set_moderator( bool $mod  )

Sets whether moderation options are available.

False by default.

Parameters:
bool   $mod:  true to enable moderation

API Tags:
Access:  public


[ Top ]
set_per_page  [line 294]

  void set_per_page( integer $pp  )

Sets how many comments should be displayed on the page.

10 by default.

Parameters:
integer   $pp:  number of comments per page

API Tags:
Access:  public


[ Top ]
set_reply  [line 304]

  void set_reply( bool $r  )

Sets whether user is allowed to reply.

True by default.

Parameters:
bool   $r:  true to allow replying

API Tags:
Access:  public


[ Top ]
tree_structure  [line 324]

  void tree_structure( bool $ts  )

Sets whether replying to specific comment is allowed.

True by default.

Parameters:
bool   $ts:  true to enable tree structure

API Tags:
Access:  public


[ Top ]

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