Index: ../subscriptions/subscriptions.admin.inc =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/subscriptions/Attic/subscriptions.admin.inc,v retrieving revision 1.1.2.15 diff -u -p -r1.1.2.15 subscriptions.admin.inc --- ../subscriptions/subscriptions.admin.inc 21 Feb 2008 22:27:39 -0000 1.1.2.15 +++ ../subscriptions/subscriptions.admin.inc 23 Feb 2008 06:31:43 -0000 @@ -2,7 +2,7 @@ // $Id: subscriptions.admin.inc,v 1.1.2.15 2008/02/21 22:27:39 chx Exp $ /** - * Admin settings + * Admin settings form. */ function subscriptions_settings_form() { $form['sub_settings'] = array( @@ -36,6 +36,9 @@ function subscriptions_settings_form() { /* user screens: display, edit functions */ /* ******************************************************* */ +/** + * Theme subscriptions controls table. + */ function theme_subscriptions_form_table($element) { $output = ''; $rows = array(); @@ -81,6 +84,9 @@ function theme_subscriptions_form_table( } +/** + * Subcriptions controls submit handler. + */ function subscriptions_page_form_submit($form_id, $form_values) { global $user; if (isset($form_values['roles'])) { @@ -131,7 +137,7 @@ function subscriptions_page_form_submit( } /** - * displays subscribed content data on user and subscription pages + * Displays subscribed content data on user and subscription pages. * @ TODO clean up all of these parts */ function subscriptions_page($account, $stype) { @@ -190,6 +196,10 @@ function subscriptions_page($account, $s return theme('box', '', $output); // . theme('xml_icon', url("subscriptions/feed")); } +/** + * Constructs page overview, which displays a summary of subscriptions per type, + * for given user. + */ function subscriptions_page_user_overview($account) { // Build summary $uid = (isset($account) ? $account->uid : -DRUPAL_AUTHENTICATED_RID); @@ -228,6 +238,12 @@ function subscriptions_page_user_overvie return $output; } +/** + * Returns form definition for user settings page. + * + * @params $account + * Must be a valid user account from user_load(). + */ function subscriptions_user_settings_form($account) { $uid = (isset($account) ? $account->uid : -DRUPAL_AUTHENTICATED_RID); @@ -357,6 +373,9 @@ function subscriptions_user_settings_for return $form; } +/** + * User settings form submit handler. + */ function subscriptions_user_settings_form_submit($form_id, $form_values) { if ($form_values['op'] == $form_values['reset']) { if (($uid = arg(1))> 0) { @@ -395,6 +414,14 @@ function subscriptions_user_settings_for } } +/** + * Provides form definition for sendding intervals settings. + * + * Called by subscriptions_menu() at subscriptions.module. + * + * @ingroup forms + * @see subscriptions_menu() + */ function subscriptions_intervals() { $default = ''; foreach (_subscriptions_send_intervals() as $interval => $text) { @@ -413,6 +440,9 @@ function subscriptions_intervals() { return $form; } +/** + * Sendding intervals settings form submit handler. + */ function subscriptions_intervals_submit($form_id, $form_values) { $intervals = array(); foreach (explode("\n", $form_values['intervals']) as $line) { @@ -424,6 +454,21 @@ function subscriptions_intervals_submit( variable_set('subscriptions_send_intervals', $intervals); } +/** + * Provides form definition for adding subscriptions. + * + * Callback of _subscriptions_menu() at subscriptions.module. + * + * @param $stype + * Subscription type. + * @param $sid + * Subscription ID. + * @param $author_uid + * User ID which which belongs to content author (commonly -1). + * + * @ingroup forms + * @see _subscriptions_menu() + */ function subscriptions_add_form($stype, $sid, $author_uid = NULL) { global $user; $form['sid'] = array('#type' => 'value', '#value' => $sid); @@ -456,6 +501,9 @@ function subscriptions_add_form($stype, return $form; } +/** + * Add subscription form submit handler. + */ function subscriptions_add_form_submit($form_id, $form_values) { if ($a = module_invoke_all('subscriptions', 'stype', $form_values['stype'], $form_values['sid'], (isset($form_values['author_uid']) ? $form_values['author_uid'] : -1))) { list($module, $field, $value, $author_uid) = $a; @@ -468,7 +516,7 @@ function subscriptions_add_form_submit($ } /** - * List of send intervals + * Returns a list of send intervals. */ function _subscriptions_send_intervals() { return variable_get('subscriptions_send_intervals', @@ -520,6 +568,9 @@ function subscriptions_form_helper(&$for } } +/** + * Implementation of hook_filter(). + */ function subscriptions_form_column_filter(&$form_table, $uid) { foreach (array('send_interval', 'send_comments', 'send_updates', 'author') as $key) { Index: ../subscriptions/subscriptions.install =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/subscriptions/subscriptions.install,v retrieving revision 1.3.2.1.2.15 diff -u -p -r1.3.2.1.2.15 subscriptions.install --- ../subscriptions/subscriptions.install 21 Feb 2008 22:27:39 -0000 1.3.2.1.2.15 +++ ../subscriptions/subscriptions.install 23 Feb 2008 06:31:44 -0000 @@ -1,6 +1,9 @@ 'value', '#value' => array($module, $field, $value, $author_uid, $recipient_uid)); return confirm_form($form, t('Are you sure you want to unsubscribe?'), '', NULL, t('Unsubscribe')); @@ -274,7 +276,7 @@ function subscriptions_delete_form_submi /** * Subscribes users to content they post, if not already subscribed - * (context: on_post, on_update, on_comment) + * (context: on_post, on_update, on_comment). */ function subscriptions_autosubscribe($module, $field, $value, $context) { global $user; @@ -285,12 +287,12 @@ function subscriptions_autosubscribe($mo } /** - * Get subscriptions + * Get subscriptions. * * @param $params - * Array of parameters for the query + * Array of parameters for the query. * @return - * Array of subscriptions indexed by uid, module, field, value, author_uid + * Array of subscriptions indexed by uid, module, field, value, author_uid. */ function subscriptions_get($params) { // Build query @@ -312,7 +314,7 @@ function subscriptions_get($params) { } /** - * Get info about subscrition types + * Hook subscription_types(). Get info about subscrition types. * * @return * Information for a given field and type @@ -341,7 +343,7 @@ function subscriptions_types($field = NU } /** - * User menu + * Given a base url, returns user menu definition for given user account. */ function _subscriptions_menu($account, $base) { global $user; Index: ../subscriptions/subscriptions_blog_ui.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/subscriptions/Attic/subscriptions_blog_ui.module,v retrieving revision 1.1.2.5 diff -u -p -r1.1.2.5 subscriptions_blog_ui.module --- ../subscriptions/subscriptions_blog_ui.module 21 Feb 2008 22:27:39 -0000 1.1.2.5 +++ ../subscriptions/subscriptions_blog_ui.module 23 Feb 2008 06:31:44 -0000 @@ -19,6 +19,17 @@ function subscriptions_blog_ui_subscript } } +/** + * Inplementation of hook_types(). + * + * This is called by subscriptions_types() at subscriptions.module. + * + * @return + * Returns information of types for Subscriptions module interface. + * + * @ingroup forms + * @see subscriptions_types() + */ function _subscriptions_blog_ui_types() { $tr = 't'; $types['blog'] = array( @@ -74,7 +85,7 @@ function subscriptions_blog_ui_page_blog } /** - * Returns the blog subscription form + * Returns the blog subscription form. */ function subscriptions_blog_ui_blog_form($blogs, $account, $form) { $uid = (isset($account) ? $account->uid : (is_numeric(arg(5)) ? -arg(5) : -DRUPAL_AUTHENTICATED_RID)); Index: ../subscriptions/subscriptions_content.install =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/subscriptions/Attic/subscriptions_content.install,v retrieving revision 1.1.2.2 diff -u -p -r1.1.2.2 subscriptions_content.install --- ../subscriptions/subscriptions_content.install 2 Feb 2008 01:47:35 -0000 1.1.2.2 +++ ../subscriptions/subscriptions_content.install 23 Feb 2008 06:31:44 -0000 @@ -1,6 +1,9 @@ _comments)) && @@ -114,6 +130,17 @@ function _subscriptions_content_access($ } +/** + * Inplementation of hook_types(). + * + * This is called by subscriptions_types() at subscriptions.module. + * + * @return + * Returns information of types for Subscriptions module interface. + * + * @ingroup forms + * @see subscriptions_types() + */ function _subscriptions_content_types() { $tr = 't'; $types['node'] = array( @@ -444,6 +471,20 @@ function subscriptions_content_form_alte } } +/** + * Fills given array of mailvars with given node values. + * + * Callback of function _subscriptions_content_node_mailvars(). + * + * @param $mailvars + * Array of mailvars to be full-filled. + * @param $node + * Node object used to fill $mailvars. + * @param $field + * Internall used for filling variable !term_name. + * @param $s + * Subscription object. + */ function _subscriptions_content_node_mailvars(&$mailvars, $node, $field, $s) { include_once drupal_get_path('module', 'subscriptions_mail') .'/subscriptions_mail.templates.inc'; @@ -498,6 +539,10 @@ function _subscriptions_content_format_t return trim($text); } +/** + * Given a comment template returns a formatted text of comments for given + * node. + */ function _subscriptions_content_format_comments($node, $comment_template, $separator) { $comments = array(); foreach ($node->_comments as $comment) { @@ -515,12 +560,25 @@ function _subscriptions_content_format_c return implode($separator, $comments); } - +/** + * Custom function for loading nodes. Load not only the node but also any + * attached comments that are in the queue. + * + * Callback on insert at subscriptions_content_nodeapi(). + * + * @param $cid + * Commend ID. + * @param $sqid + * Subscriptions queue ID. + * @param $is_new + * + * + * @return node as array(). + */ function subscriptions_content_node_load($nid, $sqid, $is_new) { // Do not cache because for different users the node can be different, // subscriptions_mail_cron caches per uid. //return node_load($nid, NULL, TRUE); - // Load not only the node but also any attached comments that are in the queue. $node = _subscriptions_content_load($nid, 0); if ($is_new) { $node->_is_new = TRUE; @@ -530,6 +588,18 @@ function subscriptions_content_node_load return $node; } +/** + * Custom function for loading comments. + * + * Callback of subscriptions_content_comment(). + * + * @param $cid + * Commend ID. + * @param $sqid + * Subscriptions queue ID. + * + * @return node as array(). + */ function subscriptions_content_comment_load($cid, $sqid) { $nid = db_result(db_query('SELECT nid FROM {comments} WHERE cid = %d', $cid)); $item = db_fetch_array(db_query('SELECT * from {subscriptions_queue} where sqid = %d', $sqid)); @@ -544,6 +614,10 @@ function subscriptions_content_comment_l return $node; } +/** + * Returns node if published, comments are limited by given subscriptions queue + * ID. + */ function _subscriptions_content_load($nid, $comment_load_sqid) { global $user; static $nodes = array(); @@ -600,6 +674,9 @@ function subscriptions_content_mailkeys( return $mailkeys; } +/** + * Custom submit handler for mail_edit_form(). + */ function subscriptions_content_mail_edit_submit($form_id, $form_values) { include_once drupal_get_path('module', 'subscriptions_mail') .'/subscriptions_mail.templates.inc'; @@ -620,14 +697,14 @@ function subscriptions_content_mail_edit } /** - * Subscriptions page callback: List thread subscriptions + * Subscriptions page callback: List thread subscriptions. */ function subscriptions_content_page_node($account, $form) { return drupal_get_form('subscriptions_content_node_form', $account, $form); } /** - * return node subscriptions form + * Return node subscriptions form. */ function subscriptions_content_node_form($account, $form) { $uid = $account->uid; @@ -693,7 +770,9 @@ function subscriptions_content_page_type return drupal_get_form('subscriptions_content_type_form', $account, $form); } -// return content type subscriptions form +/** + * Return content type subscriptions form by given $account. + */ function subscriptions_content_type_form($account, $form) { $uid = (isset($account) ? $account->uid : (is_numeric(arg(5)) ? -arg(5) : -DRUPAL_AUTHENTICATED_RID)); $unlisteds = variable_get('subscriptions_unlisted_content_types', array()); Index: ../subscriptions/subscriptions_mail.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/subscriptions/Attic/subscriptions_mail.module,v retrieving revision 1.1.2.10 diff -u -p -r1.1.2.10 subscriptions_mail.module --- ../subscriptions/subscriptions_mail.module 21 Feb 2008 22:45:46 -0000 1.1.2.10 +++ ../subscriptions/subscriptions_mail.module 23 Feb 2008 06:31:45 -0000 @@ -1,6 +1,9 @@ $name, '@to' => "<$to>"); @@ -164,7 +170,10 @@ function _subscriptions_mail_send($mailk } } -function subscriptions_mail_mail_edit_variables(&$variables, $mailkey = NULL) { +/** + * Dependency of function subscriptions_mail_cron(). + */ +function subscriptions_mail_mail_edit_variables(&$variables = NULL, $mailkey = NULL) { static $stored_variables; if (!isset($variables)) { unset($stored_variables); Index: ../subscriptions/subscriptions_mail.templates.inc =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/subscriptions/Attic/subscriptions_mail.templates.inc,v retrieving revision 1.1.2.2 diff -u -p -r1.1.2.2 subscriptions_mail.templates.inc --- ../subscriptions/subscriptions_mail.templates.inc 2 Feb 2008 01:47:35 -0000 1.1.2.2 +++ ../subscriptions/subscriptions_mail.templates.inc 23 Feb 2008 06:31:45 -0000 @@ -1,6 +1,10 @@ taxonomy) || !is_array($node->taxonomy)) { return; @@ -81,6 +95,17 @@ function _subscriptions_taxonomy_node_op return $options; } +/** + * Inplementation of hook_types(). + * + * This is called by subscriptions_types() at subscriptions.module. + * + * @return + * Returns information of types for Subscriptions module interface. + * + * @ingroup forms + * @see subscriptions_types() + */ function _subscriptions_taxonomy_types() { $tr = 't'; $types['taxa'] = array( @@ -94,6 +119,9 @@ function _subscriptions_taxonomy_types() t('subscribe to taxonomy terms'); } +/** + * Inplementation of hook_form_alter(). + */ function subscriptions_taxonomy_form_alter($form_id, &$form) { global $user; $tr = 't'; @@ -142,7 +170,7 @@ function subscriptions_taxonomy_form_alt } /** - * Returns a list of taxonomy subscriptions + * Returns a list of taxonomy subscriptions. */ function subscriptions_taxonomy_page_taxa($account, $form) { // traverse the taxonomy tree @@ -162,7 +190,7 @@ function subscriptions_taxonomy_page_tax } /** - * Returns the taxonomy subscription form + * Returns the taxonomy subscription form. */ function subscriptions_taxonomy_taxa_form($vocabularies, $account, $form) { $uid = (isset($account) ? $account->uid : (is_numeric(arg(5)) ? -arg(5) : -DRUPAL_AUTHENTICATED_RID)); @@ -261,7 +289,7 @@ function subscriptions_taxonomy_taxa_for } /* - * Implementation of hook_disable() + * Implementation of hook_disable(). */ function subscriptions_taxonomy_disable() { db_query("DELETE FROM {subscriptions_queue} WHERE module = 'node' AND field = 'tid'"); Index: ../subscriptions/subscriptions_ui.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/subscriptions/Attic/subscriptions_ui.module,v retrieving revision 1.1.2.7 diff -u -p -r1.1.2.7 subscriptions_ui.module --- ../subscriptions/subscriptions_ui.module 21 Feb 2008 22:27:39 -0000 1.1.2.7 +++ ../subscriptions/subscriptions_ui.module 23 Feb 2008 06:31:46 -0000 @@ -1,6 +1,10 @@ uid && $op == 'view' && $node->nid && !$teaser && @@ -20,6 +24,9 @@ function subscriptions_ui_nodeapi(&$node } } +/** + * Implementation of hook_block(). + */ function subscriptions_ui_block($op = 'list', $delta = 0) { switch ($op) { case 'list': @@ -38,7 +45,10 @@ function subscriptions_ui_block($op = 'l } } -function subscriptions_ui_link($type, $node = NULL, $teaser = NULL) +/** + * Implementation of hook_link(). + */ +function subscriptions_ui_link($type, $node, $teaser) { if ($type == 'node' && empty($teaser) && variable_get('subscriptions_form_link_only', 0) && arg(2) != 'subscribe' && !_subscriptions_ui_node_is_blocked($node->nid)) { @@ -54,6 +64,16 @@ function _subscriptions_ui_node_is_block return strpos(' '. variable_get('subscriptions_blocked_nodes', '') .' ', ' '. $nid .' '); } +/** + * Returns form defition of subscriptions controls. + * + * @param $node + * Must be a valid node object. + * @param $account + * If not given, will be populated with current user (either anonymous). + * + * @ingroup forms + */ function subscriptions_ui_node_form($node, $account = NULL) { global $user; if (!isset($account)) { @@ -167,6 +187,9 @@ function subscriptions_ui_node_form($nod return $form; } +/** + * Theme subscriptions controls table. + */ function theme_subscriptions_ui_table($element) { $rows = array(); $headers = array(); @@ -192,6 +215,9 @@ function theme_subscriptions_ui_table($e return $output; } +/** + * Node subscriptions controls submit handler. + */ function subscriptions_ui_node_form_submit($form_id, $form_values) { $recipient_uid = $form_values['account']->uid; @@ -213,6 +239,9 @@ function subscriptions_ui_node_form_subm return array(str_replace('/subscribe', '', $_GET['q']), NULL, (variable_get('subscriptions_form_link_only', 0) ? 'subscriptions' : NULL)); } +/** + * Implementation of hook form_alter(). + */ function subscriptions_ui_form_alter($form_id, &$form) { global $user; $tr = 't';