Node Class Reference

Public Member Functions

 Node ($con, $lang)
 WikiWord ($str)
 parseNode ($parent, $label)
 PageFromPath ($path)
 ParentFromPath ($path)
 NodeFromPath ($path)
 Subscriptions ($return_address, $action)
 Rename ()
 UpdateHistory ($action)
 RemoveNode ($node_id)
 NewNode ($clip=false)
 ParentFromId ($id)
 PathFromId ($id)
 AddRedirect ($path, $id)
 CheckRedirect ($path)

Public Attributes

 $con
 $histid
 $target
 $user
 $uid
 $lang
 $ip
 $action
 $comment
 $position
 $name
 $json
 $root

Member Function Documentation

Node::AddRedirect ( path,
id 
)

Adds a redirect to the database that will be used to send to an id from the path

Parameters:
$path The path to be inserted
$id The id of the node to be inserted
Node::CheckRedirect ( path  ) 

Checks to see if the path is in the redirect table. This is only checked if path does not exist

Parameters:
$path The path to be redirected
Returns:
The id to redirect to if found, if not -1
Node::NewNode ( clip = false  ) 

Creates a new node based on the previously set member variables

Parameters:
$clip This is used when pasting a node from the clipboard
Node::Node ( con,
lang 
)

Consructor

Parameters:
$con The connection to the mysql database
$lang The language
Node::NodeFromPath ( path  ) 

Find the id of a node from it's path

Parameters:
$path The path of the node
Returns:
The node id or NEW_PAGE if found at end of path. NO_PATH if not found.
Node::PageFromPath ( path  ) 

Find the page name based on the path

Parameters:
$path The path of the node
Returns:
The page name as a string
Node::ParentFromId ( id  ) 

Finds the parent id and the label of a node

Parameters:
$id The id of the node
Returns:
array with the parent id and the label of the node
Node::ParentFromPath ( path  ) 

Find the id of the parent node based on it's name and parent

Parameters:
$path The path of the node
Returns:
The parent id
Node::parseNode ( parent,
label 
)

Find the id of a node based on it's name and parent

Parameters:
$parent The parent id
$label The label of the node
Returns:
The node id or -1 if not found
Node::PathFromId ( id  ) 

Gets the full path of a node

Parameters:
$id The id of the node
Returns:
The full path
Node::RemoveNode ( node_id  ) 

Removes a node

Parameters:
$node_id The id of the node to be removed
Returns:
TRUE or FALSE
Node::Rename (  ) 

Renames a node

Returns:
TRUE or FALSE
Node::Subscriptions ( return_address,
action 
)

email changes to subscribers

Parameters:
$return_address The From: part of the email
$action (add,remove,rename)
Node::UpdateHistory ( action  ) 

Records the changes

Parameters:
$action (add, remove, rename)
Returns:
TRUE or FALSE
Node::WikiWord ( str  ) 

Converts a String to Wiki Word Format

Parameters:
$str The string to be converted (WikiWord)
Returns:
The converted format (Wiki Word)

The documentation for this class was generated from the following file:
Generated on Sun Feb 21 10:32:07 2010 by  doxygen 1.6.3