WeakWiki


WeakWiki\FoTopic
modules\forum\forum.support.include.php at line 35

Class FoTopic

FoTopic

public class FoTopic

This class represents a topic.


Method Summary
void

__construct(str file)

Creates a new instance of the class.

void

addTopic(mixed topic)

Adds a subtopic to the topic.

void

editable()

Returns if the current user is allowed to edit the document.

void

getFileName()

Gets the topic's file name.

void

getParent()

Returns the parent topic of this topic.

void

getPermissions(mixed ul)

Gets the permissions for a user group.

void

getPrivileges()

Gets the topic's privileges.

void

getText()

Gets the topic's text.

void

getThreads()

Returns the threads in this topic.

void

getTitle()

Gets the topic's title.

void

getTopics()

Returns the topics in this topic.

protected void

load()

Loads topic from file.

protected void

readPermissions()

Evaluates the topic's permissions.

void

readable()

Returns if the current user is allowed to read the document.

void

request(mixed op)

Checks if an operation is allowed for the current user.

void

save()

Serializes the object into a topic file.

void

serialize()

Serializes the object into a string.

void

setParent(mixed value)

Sets the parent topic of this topic.

void

setPrivileges(mixed value)

Sets the topic's privileges.

void

setText(mixed value)

Sets the topic's text.

void

setTitle(mixed value)

Sets the topic's title.

Method Detail

modules\forum\forum.support.include.php at line 77

__construct

public void __construct(str file)

Creates a new instance of the class.


modules\forum\forum.support.include.php at line 275

addTopic

public void addTopic(mixed topic)

Adds a subtopic to the topic. @param $topic Topic.


modules\forum\forum.support.include.php at line 255

editable

public void editable()

Returns if the current user is allowed to edit the document. @return TRUE if the document may be edited, otherwise FALSE.


modules\forum\forum.support.include.php at line 142

getFileName

public void getFileName()

Gets the topic's file name. @return Returns the file name.


modules\forum\forum.support.include.php at line 284

getParent

public void getParent()

Returns the parent topic of this topic. @return Parent topic.


modules\forum\forum.support.include.php at line 265

getPermissions

public void getPermissions(mixed ul)

Gets the permissions for a user group. @param $ul User level: UL_UNKNOWN, UL_READ, UL_EDIT, UL_ADMIN. @return Permission set.


modules\forum\forum.support.include.php at line 126

getPrivileges

public void getPrivileges()

Gets the topic's privileges. @return Returns the privileges.


modules\forum\forum.support.include.php at line 110

getText

public void getText()

Gets the topic's text. @return Returns the text.


modules\forum\forum.support.include.php at line 170

getThreads

public void getThreads()

Returns the threads in this topic. @return Threads.


modules\forum\forum.support.include.php at line 94

getTitle

public void getTitle()

Gets the topic's title. @return Returns the title.


modules\forum\forum.support.include.php at line 150

getTopics

public void getTopics()

Returns the topics in this topic. @return Topics.


modules\forum\forum.support.include.php at line 304

load

protected void load()

Loads topic from file.


modules\forum\forum.support.include.php at line 331

readPermissions

protected void readPermissions()

Evaluates the topic's permissions.


modules\forum\forum.support.include.php at line 247

readable

public void readable()

Returns if the current user is allowed to read the document. @return TRUE if the document may be read, otherwise FALSE.


modules\forum\forum.support.include.php at line 234

request

public void request(mixed op)

Checks if an operation is allowed for the current user. @param $op Operation string: OP_READ, OP_WRITE, OP_ADMIN. @return TRUE if operation is permittet, otherwise FALSE.


modules\forum\forum.support.include.php at line 216

save

public void save()

Serializes the object into a topic file.


modules\forum\forum.support.include.php at line 187

serialize

public void serialize()

Serializes the object into a string.


modules\forum\forum.support.include.php at line 292

setParent

public void setParent(mixed value)

Sets the parent topic of this topic. @param value Parent topic.


modules\forum\forum.support.include.php at line 134

setPrivileges

public void setPrivileges(mixed value)

Sets the topic's privileges. @param $value Privileges.


modules\forum\forum.support.include.php at line 118

setText

public void setText(mixed value)

Sets the topic's text. @param $value Text.


modules\forum\forum.support.include.php at line 102

setTitle

public void setTitle(mixed value)

Sets the topic's title. @param $value Title.


WeakWiki