Docs For Class Comment

Class Overview

Comment Class

Located in /blogs/b2evocore/_class_comment.php [line 23]

DataObject
   |
   --Comment

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObject DataObject::$ID	Inherited From DataObject DataObject::DataObject() Constructor DataObject::dbchange() Records a change that will need to be updated in the db DataObject::dbdelete() DataObject::dbinsert() DataObject::dbupdate() DataObject::dget() Get a ready-to-display member param by its name DataObject::disp() Display a member param by its name DataObject::get() Get a member param by its name DataObject::ID() Template function: Displays object ID DataObject::set_param() Set param value

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObject

DataObject::$ID

Inherited From DataObject

DataObject::DataObject()

Constructor

DataObject::dbchange()

Records a change that will need to be updated in the db

DataObject::dbdelete()

DataObject::dbinsert()

DataObject::dbupdate()

DataObject::dget()

Get a ready-to-display member param by its name

DataObject::disp()

Display a member param by its name

DataObject::get()

Get a member param by its name

DataObject::ID()

Template function: Displays object ID

DataObject::set_param()

Set param value

[ Top ]

Property Summary

mixed	$author
mixed	$author_email
mixed	$author_ip
mixed	$author_url
mixed	$author_User
mixed	$content
mixed	$date
mixed	$Item
mixed	$karma
mixed	$status
mixed	$type

[ Top ]

Method Summary

Comment	Comment()
void	anchor()	Template function: display anchor for permalinks to refer to
void	author()	Template function: display author of comment
void	author_email()	Template function: display link to comment author's provided email
void	author_ip()	Template function: display comment's author's IP
boolean	author_url()	Template function: display link to comment author's provided URL
void	content()	Template function: display content of comment
void	date()	Template function: display date (datetime) of comment
void	delete_link()	Displays button for deleeing the Comment if user has proper rights
void	edit_link()	Provide link to edit a comment if user has edit rights
void	permalink()	Template function: display permalink to this comment
void	set()
void	time()	Template function: display time (datetime) of comment

[ Top ]

Properties

mixed $author [line 32]

[ Top ]

mixed $author_email [line 33]

[ Top ]

mixed $author_ip [line 35]

[ Top ]

mixed $author_url [line 34]

[ Top ]

mixed $author_User = NULL [line 29]

[ Top ]

mixed $content [line 37]

[ Top ]

mixed $date [line 36]

[ Top ]

mixed $Item = NULL [line 28]

API Tags:

Access:

protected

[ Top ]

mixed $karma [line 38]

[ Top ]

mixed $status [line 31]

[ Top ]

mixed $type [line 30]

[ Top ]

Methods

Constructor Comment [line 45]

Comment Comment(
[
$db_row = NULL] 
)

Parameters:

$db_row:

[ Top ]

anchor [line 112]

void anchor(
)

Template function: display anchor for permalinks to refer to

[ Top ]

author [line 130]

void author(
[string
$before = ''], [string
$after = '#'], [string
$before_user = ''], [string
$after_user = '#'], [string
$format = 'htmlbody'], [boolean
$makelink = false] 
)

Template function: display author of comment

Parameters:

string	$before:	String to display before author name if not a user
string	$after:	String to display after author name if not a user
string	$before_user:	String to display before author name if he's a user
string	$after_user:	String to display after author name if he's a user
string	$format:	Output format, see format_to_output()
boolean	$makelink:	true for link, false if you want NO html link

[ Top ]

author_email [line 182]

void author_email(
[string
$linktext = ''], [string
$before = ''], [string
$after = ''], [boolean
$makelink = true] 
)

Template function: display link to comment author's provided email

Parameters:

string	$linktext:	String to display for link: leave empty to display email
string	$before:	String to display before email, if email exists
string	$after:	String to display after email, if email exists
boolean	$makelink:	false if you want NO html link

[ Top ]

author_ip [line 161]

void author_ip(
[string
$before = ''], [string
$after = ''] 
)

Template function: display comment's author's IP

Parameters:

string	$before:	String to display before IP, if IP exists
string	$after:	String to display after IP, if IP exists

[ Top ]

author_url [line 215]

boolean author_url(
[string
$linktext = ''], [string
$before = ''], [string
$after = ''], [boolean
$makelink = true] 
)

Template function: display link to comment author's provided URL

Parameters:

string	$linktext:	String to display for link: leave empty to display URL
string	$before:	String to display before link, if link exists
string	$after:	String to display after link, if link exists
boolean	$makelink:	false if you want NO html link

API Tags:

Return:

true if URL has been displayed

[ Top ]

content [line 364]

void content(
[string
$format = 'htmlbody'] 
)

Template function: display content of comment

Parameters:

string

$format:

Output format, see format_to_output()

[ Top ]

date [line 381]

void date(
[string
$format = ''], [boolean
$useGM = false] 
)

Template function: display date (datetime) of comment

Parameters:

string	$format:	date/time format: leave empty to use locale default date format
boolean	$useGM:	true if you want GMT

[ Top ]

delete_link [line 288]

void delete_link(
[string
$before = ' '], [string
$after = ' '], [string
$text = '#'], [string
$title = '#'], [string
$class = ''], [boolean
$button = false] 
)

Displays button for deleeing the Comment if user has proper rights

Parameters:

string	$before:	to display before link
string	$after:	to display after link
string	$text:	link text
string	$title:	link title
string	$class:	class name
boolean	$button:	true to make this a button instead of a link

[ Top ]

edit_link [line 251]

void edit_link(
[string
$before = ' '], [string
$after = ' '], [string
$text = '#'], [string
$title = '#'], [string
$class = ''] 
)

Provide link to edit a comment if user has edit rights

Parameters:

string	$before:	to display before link
string	$after:	to display after link
string	$text:	link text
string	$title:	link title
string	$class:	class name

[ Top ]

permalink [line 338]

void permalink(
[string
$mode = ''], [string
$blogurl = ''] 
)

Template function: display permalink to this comment

Parameters:

string	$mode:	'urltitle', 'pid', 'archive#id' or 'archive#title'
string	$blogurl:	url to use

[ Top ]

set [line 90]

void set(

$parname, 
$parvalue 
)

Parameters:

	$parname:
	$parvalue:

[ Top ]

time [line 397]

void time(
[string
$format = ''], [boolean
$useGM = false] 
)

Template function: display time (datetime) of comment

Parameters:

string	$format:	date/time format: leave empty to use locale default time format
boolean	$useGM:	true if you want GMT

[ Top ]

Multilingual multiuser multiblog engine

Class: Comment

Class Comment

Packages

Classes

Files