Added documentation

This commit is contained in:
Michael 2017-09-14 06:10:33 +00:00
parent 92537d6926
commit c3589dc043

View file

@ -290,6 +290,13 @@ function network_query_get_sel_group(App $a) {
return $group; return $group;
} }
/**
* @brief Sets the pager data and returns SQL
*
* @param App $a The global App
* @param integer $update Used for the automatic reloading
* @return string SQL with the appropriate LIMIT clause
*/
function networkPager($a, $update) { function networkPager($a, $update) {
if ($update) { if ($update) {
// only setup pagination on initial page view // only setup pagination on initial page view
@ -318,6 +325,11 @@ function networkPager($a, $update) {
return sprintf(" LIMIT %d, %d ",intval($a->pager['start']), intval($a->pager['itemspage'])); return sprintf(" LIMIT %d, %d ",intval($a->pager['start']), intval($a->pager['itemspage']));
} }
/**
* @brief Sets items as seen
*
* @param array $condition The array with the SQL condition
*/
function networkSetSeen($condition) { function networkSetSeen($condition) {
if (empty($condition)) { if (empty($condition)) {
return; return;
@ -330,6 +342,15 @@ function networkSetSeen($condition) {
} }
} }
/**
* @brief Create the conversation HTML
*
* @param App $a The global App
* @param array $items Items of the conversation
* @param string $mode Display mode for the conversation
* @param integer $update Used for the automatic reloading
* @return string HTML of the conversation
*/
function networkConversation($a, $items, $mode, $update) { function networkConversation($a, $items, $mode, $update) {
// Set this so that the conversation function can find out contact info for our wall-wall items // Set this so that the conversation function can find out contact info for our wall-wall items
$a->page_contact = $a->contact; $a->page_contact = $a->contact;