blob: 246bb11a31b0ff2af62decac264b0a40fc0cebaf (
plain) (
tree)
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>The Red Project: Conversation Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="fred-48.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">The Red Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classConversation.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classConversation-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Conversation Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Conversation:</div>
<div class="dyncontent">
<div class="center">
<img src="classConversation.png" usemap="#Conversation_map" alt=""/>
<map id="Conversation_map" name="Conversation_map">
<area href="classBaseObject.html" alt="BaseObject" shape="rect" coords="0,0,87,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6b064d00c56a6b7dec359d4348711c84"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a6b064d00c56a6b7dec359d4348711c84">__construct</a> ($mode, $preview)</td></tr>
<tr class="separator:a6b064d00c56a6b7dec359d4348711c84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87a0d704d5f2b1a008cc2e9ce06a1bcd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a87a0d704d5f2b1a008cc2e9ce06a1bcd">get_mode</a> ()</td></tr>
<tr class="separator:a87a0d704d5f2b1a008cc2e9ce06a1bcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5879199008b96bee7550b576d614e1c1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a5879199008b96bee7550b576d614e1c1">is_writable</a> ()</td></tr>
<tr class="separator:a5879199008b96bee7550b576d614e1c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf25ce023b69a166c63c6e84e02c136a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#adf25ce023b69a166c63c6e84e02c136a">is_preview</a> ()</td></tr>
<tr class="separator:adf25ce023b69a166c63c6e84e02c136a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5effe8ad3007e01333df44b81432b813"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a5effe8ad3007e01333df44b81432b813">get_profile_owner</a> ()</td></tr>
<tr class="separator:a5effe8ad3007e01333df44b81432b813"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8335cdd43f1836e3c255638e61a09e16"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a8335cdd43f1836e3c255638e61a09e16">add_thread</a> ($item)</td></tr>
<tr class="separator:a8335cdd43f1836e3c255638e61a09e16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a96b7a6573ae53db861624659e831cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a2a96b7a6573ae53db861624659e831cb">get_template_data</a> ($alike, $dlike)</td></tr>
<tr class="separator:a2a96b7a6573ae53db861624659e831cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classBaseObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classBaseObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classBaseObject.html">BaseObject</a></td></tr>
<tr class="memitem:ac43f10e69ce80c78e4870636250fc8a2 inherit pub_methods_classBaseObject"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBaseObject.html#ac43f10e69ce80c78e4870636250fc8a2">get_app</a> ()</td></tr>
<tr class="separator:ac43f10e69ce80c78e4870636250fc8a2 inherit pub_methods_classBaseObject"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a66f121ca4026246f86a732e5faa0682c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a66f121ca4026246f86a732e5faa0682c">set_mode</a> ($mode)</td></tr>
<tr class="separator:a66f121ca4026246f86a732e5faa0682c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cff75d8c46b517e7133e4d0da6fc1c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a4cff75d8c46b517e7133e4d0da6fc1c8">get_thread</a> ($id)</td></tr>
<tr class="separator:a4cff75d8c46b517e7133e4d0da6fc1c8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a41f4a549e6a99f98935c4742addd22c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a41f4a549e6a99f98935c4742addd22c8">$threads</a> = array()</td></tr>
<tr class="separator:a41f4a549e6a99f98935c4742addd22c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb03d1648dbfafe62caa1e30f32f2b1a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#afb03d1648dbfafe62caa1e30f32f2b1a">$mode</a> = null</td></tr>
<tr class="separator:afb03d1648dbfafe62caa1e30f32f2b1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae81221251307e315f566a11f921ce0a9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#ae81221251307e315f566a11f921ce0a9">$writable</a> = false</td></tr>
<tr class="separator:ae81221251307e315f566a11f921ce0a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f12724ef0244e9049fe1bb9641b516d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#a2f12724ef0244e9049fe1bb9641b516d">$profile_owner</a> = 0</td></tr>
<tr class="separator:a2f12724ef0244e9049fe1bb9641b516d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9937f9e0f3d927acc2bed46cc72e9ae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classConversation.html#ae9937f9e0f3d927acc2bed46cc72e9ae">$preview</a> = false</td></tr>
<tr class="separator:ae9937f9e0f3d927acc2bed46cc72e9ae"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classBaseObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classBaseObject')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classBaseObject.html">BaseObject</a></td></tr>
<tr class="memitem:a0a9acda12d751692834cf6999f889223 inherit pub_static_methods_classBaseObject"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classBaseObject.html#a0a9acda12d751692834cf6999f889223">set_app</a> ($app)</td></tr>
<tr class="separator:a0a9acda12d751692834cf6999f889223 inherit pub_static_methods_classBaseObject"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A list of threads</p>
<p>We should think about making this a SPL Iterator </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6b064d00c56a6b7dec359d4348711c84"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Conversation::__construct </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$preview</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8335cdd43f1836e3c255638e61a09e16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Conversation::add_thread </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$item</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a thread to the conversation</p>
<p>Returns: _ The inserted item on success _ false on failure </p>
</div>
</div>
<a class="anchor" id="a87a0d704d5f2b1a008cc2e9ce06a1bcd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Conversation::get_mode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get mode </p>
<p>Referenced by <a class="el" href="classConversation.html#a66f121ca4026246f86a732e5faa0682c">set_mode()</a>.</p>
</div>
</div>
<a class="anchor" id="a5effe8ad3007e01333df44b81432b813"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Conversation::get_profile_owner </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get profile owner </p>
</div>
</div>
<a class="anchor" id="a2a96b7a6573ae53db861624659e831cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Conversation::get_template_data </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$alike</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$dlike</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get data in a form usable by a conversation template</p>
<p>We should find a way to avoid using those arguments (at least most of them)</p>
<p>Returns: _ The data requested on success _ false on failure </p>
</div>
</div>
<a class="anchor" id="a4cff75d8c46b517e7133e4d0da6fc1c8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Conversation::get_thread </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$id</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a thread based on its item id</p>
<p>Returns: _ The found item on success _ false on failure </p>
<p>Referenced by <a class="el" href="classConversation.html#a8335cdd43f1836e3c255638e61a09e16">add_thread()</a>.</p>
</div>
</div>
<a class="anchor" id="adf25ce023b69a166c63c6e84e02c136a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Conversation::is_preview </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if page is a preview </p>
</div>
</div>
<a class="anchor" id="a5879199008b96bee7550b576d614e1c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Conversation::is_writable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if page is writable </p>
</div>
</div>
<a class="anchor" id="a66f121ca4026246f86a732e5faa0682c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Conversation::set_mode </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the mode we'll be displayed on </p>
<p>Referenced by <a class="el" href="classConversation.html#a6b064d00c56a6b7dec359d4348711c84">__construct()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="afb03d1648dbfafe62caa1e30f32f2b1a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Conversation::$mode = null</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classConversation.html#a6b064d00c56a6b7dec359d4348711c84">__construct()</a>, <a class="el" href="classConversation.html#a87a0d704d5f2b1a008cc2e9ce06a1bcd">get_mode()</a>, and <a class="el" href="classConversation.html#a66f121ca4026246f86a732e5faa0682c">set_mode()</a>.</p>
</div>
</div>
<a class="anchor" id="ae9937f9e0f3d927acc2bed46cc72e9ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Conversation::$preview = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classConversation.html#a6b064d00c56a6b7dec359d4348711c84">__construct()</a>, and <a class="el" href="classConversation.html#adf25ce023b69a166c63c6e84e02c136a">is_preview()</a>.</p>
</div>
</div>
<a class="anchor" id="a2f12724ef0244e9049fe1bb9641b516d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Conversation::$profile_owner = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classConversation.html#a5effe8ad3007e01333df44b81432b813">get_profile_owner()</a>.</p>
</div>
</div>
<a class="anchor" id="a41f4a549e6a99f98935c4742addd22c8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Conversation::$threads = array()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae81221251307e315f566a11f921ce0a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Conversation::$writable = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="classConversation.html#a5879199008b96bee7550b576d614e1c1">is_writable()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/<a class="el" href="ConversationObject_8php.html">ConversationObject.php</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classConversation.html">Conversation</a></li>
<li class="footer">Generated on Tue Feb 26 2013 15:43:22 for The Red Project by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3.1 </li>
</ul>
</div>
</body>
</html>
|
