node Class Reference

represents a wiki node with content, translations, acls ... More...

List of all members.

Public Member Functions

 node ($id, $title, $alternate_title, $content, $commit_msg, $minor_major, $ip, $timestamp, $lang, $parent_id, $left, $right, $related_content_id, $user_id, $login, $first_name, $last_name, $email)
 setParents ($parents)
 setLinks ($links)
 setComments ($comments)
 setGroups ($groups)
 setLangs ($langs)
 isRootNode ()
 is this node the root node of the wiki ? (the parent of all other pages)
 isMasterNode ()
 is this node a node in main lang ? (the lang defined as the main lang of the wiki)
 isTranslationNode ()
 is this node a translation ? (not in the lang defined as the main lang of the wiki)
 toHtml ($showTOC, $editBySection, $allLangs=array(), $canEdit=true)
 format this node in html format

Public Attributes

 $id
 database id
 $title
 title
 $alternate_title
 alternate title (may be empty)
 $content
 content
 $commit_msg
 commit message used
 $minor_major
 minor/major changement ?
 $ip
 ip of user that last modified the node
 $timestamp
 date of last modification
 $lang
 lang object
 $parent_id
 database id of parent
 $left
 nested set model 'left' value
 $right
 nested set model 'right' value
 $related_content_id
 master node id (if equals to id, this node is a master node)
 $user_id
 database id of user that last modified the node or 0 if user was anonymous
 $login
 login of anonymous user
 $first_name
 first name of anonymous user
 $last_name
 last name of anonymous user
 $email
 email of anonymous user
 $groups
 array<acl_type => array<id => group> >
 $langs
 array<id=>lang>
 $extra
 array<string=>whatever>


Detailed Description

represents a wiki node with content, translations, acls ...


Member Function Documentation

node::isMasterNode (  ) 

is this node a node in main lang ? (the lang defined as the main lang of the wiki)

Returns:
true if this is a master node

node::isRootNode (  ) 

is this node the root node of the wiki ? (the parent of all other pages)

Returns:
true if this is the root node

node::isTranslationNode (  ) 

is this node a translation ? (not in the lang defined as the main lang of the wiki)

Returns:
true if this is a translation

node::toHtml ( showTOC,
editBySection,
allLangs = array(),
canEdit = true 
)

format this node in html format

if allLangs is not empty, a list of images will be generated

Parameters:
showTOC display or not TOC
editBySection display Edit link on each section
allLangs array<lang>
canEdit provides link to translate the node
Returns:
html representation of node


Member Data Documentation

node::$alternate_title

alternate title (may be empty)

node::$commit_msg

commit message used

node::$content

content

node::$email

email of anonymous user

node::$extra

array<string=>whatever>

node::$first_name

first name of anonymous user

node::$groups

array<acl_type => array<id => group> >

node::$id

database id

node::$ip

ip of user that last modified the node

node::$lang

lang object

node::$langs

array<id=>lang>

node::$last_name

last name of anonymous user

node::$left

nested set model 'left' value

node::$login

login of anonymous user

node::$minor_major

minor/major changement ?

node::$parent_id

database id of parent

node::$related_content_id

master node id (if equals to id, this node is a master node)

node::$right

nested set model 'right' value

node::$timestamp

date of last modification

node::$title

title

node::$user_id

database id of user that last modified the node or 0 if user was anonymous


The documentation for this class was generated from the following file:
Generated on Mon Feb 19 19:11:58 2007 for Wiclear by  doxygen 1.4.7