Overview

Namespaces

None
Xmf
- Database
- Module
  - Helper
- Template
Xoops
- Auth
- Core
  - Cache
  - Database
    - Logging
    - Schema
  - Exception
  - Handler
    - Scheme
  - Kernel
    - Dtype
    - Handlers
    - Model
  - Lists
  - Locale
    - Punic
  - Service
    - Contract
  - Session
  - Text
    - Sanitizer
      - Extensions
  - Theme
    - Plugins
- Form
- Html
- Locale
- Module
  - Helper
  - Plugin

Classes

Interfaces

Functions

Interface CommentsPluginInterface

Direct known implementers

PageCommentsPlugin, PublisherCommentsPlugin

Copyright: XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Version: $Id$
Located at odules/comments/class/plugin/interface.php

Methods summary
`public string`	# `itemName( )` You must return the unique identifier for the item ex: return 'itemid'; You must return the unique identifier for the item ex: return 'itemid'; Returns string
`public string`	# `pageName( )` You must return the page where the comment form is displayed ex: return 'item.php'; You must return the page where the comment form is displayed ex: return 'item.php'; Returns string
`public array`	# `extraParams( )` Returns array
`public`	# `approve( CommentsComment $comment )` This method will be executed upon successful post of an approved comment. This includes comment posts by administrators, and change of comment status from 'pending' to 'active' state. An CommentsComment object that has been approved will be passed as the first and only parameter. This should be useful for example notifying the item submitter of a comment post. This method will be executed upon successful post of an approved comment. This includes comment posts by administrators, and change of comment status from 'pending' to 'active' state. An CommentsComment object that has been approved will be passed as the first and only parameter. This should be useful for example notifying the item submitter of a comment post. Parameters `$comment`
`public`	# `update( integer $item_id, integer $total_num )` This method will be executed whenever the total number of 'active' comments for an item is changed. This method will be executed whenever the total number of 'active' comments for an item is changed. Parameters `$item_id` The unique ID of an item `$total_num` The total number of active comments
`public array`	# `itemInfo( integer $item_id )` This method will be executed whenever a new comment form is displayed. You can set a default title for the comment and a header to be displayed on top of the form ex: return array( 'title' => 'My Article Title', 'text' => 'Content of the article'); 'timestamp' => time(); //Date of the article in unix format 'uid' => Id of the article author This method will be executed whenever a new comment form is displayed. You can set a default title for the comment and a header to be displayed on top of the form ex: return array( 'title' => 'My Article Title', 'text' => 'Content of the article'); 'timestamp' => time(); //Date of the article in unix format 'uid' => Id of the article author Parameters `$item_id` The unique ID of an item Returns array