',
+ );
+ }
-/**
- * Implementation of hook_submit().
- * Submit the delete user titles form.
- */
-function user_titles_delete_title_form_submit($form, &$form_state) {
- if ($form_state['values']['tid'] && is_numeric($form_state['values']['tid'])) {
- $success = db_query("DELETE FROM {user_titles} WHERE tid = %d", $form_state['values']['tid']);
- }
+ $form['user_titles']['user_title'] = array(
+ '#type' => 'textfield',
+ '#title' => t('Override title'),
+ '#description' => t('Enter a title here to give this user a manually overridden title. Leave blank to use the default title.'),
+ '#default_value' => isset($user->user_title) ? $user->user_title : '',
+ );
- if ($success) {
- drupal_set_message("User title '" . $form_state['values']['title'] . "' has been deleted successfully.", 'status');
- }
- else {
- drupal_set_message("Deletion of user title '" . $form_state['values']['title'] . "' has failed.", 'error');
+ return $form;
+ }
+ break;
+ case 'delete':
+ db_query('DELETE FROM {user_titles_posts} WHERE uid = %d', $user->uid);
+ break;
+ case 'view':
+ $title = user_titles_get_user_title($user);
+ if ($title) {
+ $user->content['user_titles'] = array(
+ '#type' => 'user_profile_category',
+ '#title' => t('User title'),
+ );
+ $user->content['user_titles']['title'] = array(
+ '#type' => 'user_profile_item',
+ '#value' => filter_xss_admin($title),
+ );
+ }
+ break;
}
-
- $form_state['redirect'] = 'admin/user/user-titles';
- return;
}
/**
- * Implementation of hook_nodeapi
+ * Get the currently used hook module.
+ *
+ * @return
+ * A string containing the name of the module that is being used to calculate user titles.
*/
-function user_titles_nodeapi(&$node, $op, $a3 = NULL, $a4 = NULL) {
- if ($op == 'insert' || $op == 'delete') {
- $allowed_types = user_titles_get_allowed_types();
- if (in_array($node->type, $allowed_types)) {
- $inc = ($op == 'insert') ? 1 : -1;
- db_query("UPDATE {user_titles_posts} SET posts = %d WHERE uid = %d", user_titles_get_posts($node->uid) + $inc, $node->uid);
- if (!db_affected_rows()) {
- db_query("INSERT INTO {user_titles_posts} (uid, posts) VALUES (%d, %d)", $node->uid, user_titles_get_posts($node->uid) + $inc);
- }
- }
+function user_titles_get_hook_module() {
+ $default = 'user_titles';
+ $module = variable_get('user_titles_hook_module', $default);
+ if (module_exists($module)) {
+ return $module;
+ }
+ else {
+ return $default;
}
}
/**
- * Implementation of hook_comment.
+ * Set the currently used hook module.
+ *
+ * @param
+* A string containing the name of the module that is being used to calculate user titles.
*/
-function user_titles_comment($a1, $op) {
- if ($op == 'insert' || $op == 'delete') {
- $a1 = (object)$a1; // sometimes an array is passed in
- $node = node_load($a1->nid);
- $types = user_titles_get_allowed_types();
- if (in_array($node->type, $types)) {
- $uid = $a1->uid;
- $inc = ($op == 'insert') ? 1 : -1;
- db_query("UPDATE {user_titles_posts} SET posts = %d WHERE uid = %d", user_titles_get_posts($uid) + $inc, $uid);
- if (!db_affected_rows()) {
- db_query("INSERT INTO {user_titles_posts} (uid, posts) VALUES (%d, %d)", $uid, user_titles_get_posts($uid) + $inc);
- }
- }
- }
+function user_titles_set_hook_module($module) {
+ variable_set('user_titles_hook_module', $module);
}
/**
- * Load the number of posts for a user. If we don't have a stored count
- * in the database, count and store that value.
+ * Get the number of posts for a user.
+ * If we don't have a stored count in the database, count and store that value.
*
- * @todo When porting to 7.x, rename to user_title_get_points
+ * @todo When porting to 7.x, rename to user_title_get_points.
*
* @param $uid
- * The user to fetch the number of posts for.
+ * An integer containing the uid of the user to fetch the number of posts for.
+ *
+ * @return
+ * An integer containing the number of posts for the user.
*/
function user_titles_get_posts($uid) {
static $cache = array();
if (!isset($cache[$uid])) {
- $module = user_titles_hook_module();
+ $module = user_titles_get_hook_module();
$cache[$uid] = module_invoke($module, 'user_titles', 'get', $uid);
}
return $cache[$uid];
}
/**
- * Calculate a title based upon the number of posts.
+ * Calculate a title based upon the number of posts and user role.
*
* @param $posts
* The number of posts to find the title for.
+ * @param $rid
+ * The role id to get the title for.
+ * If $rid is NULL the default user titles role will be used.
+ *
+ * @return
+ * A title object for the number of posts and role.
*/
-function user_titles_get_title($posts) {
- $titles = user_titles_get_titles();
+function user_titles_get_title($posts, $rid = NULL) {
+ if (!$rid) {
+ $rid = user_titles_get_default_role();
+ }
+ $titles = user_titles_get_titles_by_role($rid);
// This array will be sorted from highest to lowest prior to storing.
foreach ($titles as $title) {
- if ($posts >= $title['value']) {
+ if ($posts >= $title->value) {
return $title;
}
}
@@ -569,39 +376,39 @@ function user_titles_get_title($posts) {
/**
* Fetch a title for the given user.
*
- * @param $account
- * The user to fetch. May be a $user object or a $uid.
+ * @param $user
+ * The user to fetch the title for. May be a $user object or a $uid.
*/
-function user_titles_get_user_title($account) {
- $title = user_titles_get_user_title_info($account);
- if (isset($title['title'])) {
- return $title['title'];
+function user_titles_get_user_title($user) {
+ $title = user_titles_get_user_title_info($user);
+ if (isset($title->title)) {
+ return $title->title;
}
}
/**
* Fetch the user title image path for the given user.
*
- * @param $account
- * The user to fetch. May be a $user object or a $uid.
+ * @param $user
+ * The user to fetch the image path for. May be a $user object or a $uid.
*/
-function user_titles_get_user_image_path($account) {
- $title = user_titles_get_user_title_info($account);
- if (isset($title['image'])) {
- return $title['image'];
+function user_titles_get_user_image_path($user) {
+ $title = user_titles_get_user_title_info($user);
+ if (isset($title->image)) {
+ return $title->image;
}
}
/**
* Fetch the themed user title image for the given user.
*
- * @param $account
- * The user to fetch. May be a $user object or a $uid.
+ * @param $user
+ * The user to fetch the image for. May be a $user object or a $uid.
*/
-function user_titles_get_user_image($account) {
- $title = user_titles_get_user_title_info($account);
- if (isset($title['image'])) {
- return theme('user_titles_image', $title['image'], $title['image_title']);
+function user_titles_get_user_image($user) {
+ $title = user_titles_get_user_title_info($user);
+ if (isset($title->image)) {
+ return theme('user_titles_image', $title->image, $title->image_title);
}
}
@@ -611,48 +418,66 @@ function user_titles_get_user_image($acc
* @param $uid
* The user to fetch. May be a $user object or a $uid.
*/
-function user_titles_get_user_title_info($account) {
- if (is_numeric($account)) {
- $account = user_load(array('uid' => $account));
+function user_titles_get_user_title_info($user) {
+ if (is_numeric($user)) {
+ $user = user_load(array('uid' => $user));
}
- if (!$account) {
+ if (!$user) {
return;
}
- if (!empty($account->user_title)) {
- return array('title' => $account->user_title);
+ if (!empty($user->user_title)) {
+ return array('title' => $user->user_title);
}
- return user_titles_get_title(user_titles_get_posts($account->uid));
+ $rid = user_titles_get_users_title_role($user->uid);
+
+ return user_titles_get_title(user_titles_get_posts($user->uid), $rid);
}
/**
* Returns the next highest title from the given title
*/
-function user_titles_get_next_higher_title($tid) {
- $title = db_fetch_array(db_query("SELECT * FROM {user_titles} WHERE value > (SELECT value FROM user_titles WHERE tid = %d) ORDER BY value LIMIT 1", $tid));
+function user_titles_get_next_higher_title($tid, $rid) {
+ $title = db_fetch_object(db_query_range("SELECT *
+ FROM {user_titles}
+ WHERE value > (SELECT value
+ FROM user_titles
+ WHERE tid = %d)
+ AND rid = %d
+ ORDER BY value", $tid, $rid, 0, 1));
return $title;
}
/**
- * Get users (uids) that have a given title
+ * Get users (uids) that have a given title in a given role.
*
- * @param $uid
- * The user to fetch. May be a $user object or a $uid.
+ * @param $user
+ * The user object to fetch the matching users for.
*/
-function user_titles_get_matching_users($uid) {
- $title = user_titles_get_user_title_info($uid);
- $next_title = user_titles_get_next_higher_title($title['tid']);
+function user_titles_get_matching_users($user) {
+ $title = user_titles_get_user_title_info($user->uid);
+ $next_title = user_titles_get_next_higher_title($title->tid, $title->rid);
if ($next_title !== FALSE) {
- $result = db_query("SELECT uid FROM {user_titles_posts} WHERE posts >= %d AND posts < %d AND uid NOT IN (0, %d)", $title['value'], $next_title['value'], $uid);
+ $result = db_query("SELECT uid
+ FROM {user_titles_posts}
+ WHERE posts >= %d
+ AND posts < %d
+ AND uid NOT IN (0, %d)", $title->value, $next_title->value, $user->uid);
}
else {
- $result = db_query("SELECT uid FROM {user_titles_posts} WHERE posts >= %d AND uid NOT IN (0, %d)", $title['value'], $uid);
+ $result = db_query("SELECT uid
+ FROM {user_titles_posts}
+ WHERE posts >= %d
+ AND uid NOT IN (0, %d)", $title->value, $user->uid);
}
$users = array();
while ($row = db_fetch_array($result)) {
- $users[] = $row['uid'];
+ // Only return users in the same user titles role
+ if (user_titles_get_users_title_role($row['uid']) == $title->rid) {
+ $users[] = $row['uid'];
+ }
}
return $users;
@@ -666,29 +491,45 @@ function user_titles_get_matching_users(
* @param $count
* The count to write. If not given, posts will be counted and that data
* written.
+ *
+ * @return
+ * The post count for the user.
*/
function user_titles_update_post_count($uid, $count = NULL) {
if (is_null($count)) {
- // fetch count from the database
+ // Fetch count from the database
$allowed_types = user_titles_get_allowed_types();
if ($allowed_types) {
- $types = implode("','", $allowed_types);
- $count = db_result(db_query("SELECT COUNT(*) FROM {node} WHERE uid = %d AND type IN ('$types')", $uid));
+ $in = '';
+ $query_args = array($uid);
+ foreach ($allowed_types as $type) {
+ $query_args[] = $type;
+ $in .= $in ? ", '%s'" : "'%s'";
+ }
+ $count = db_result(db_query("SELECT COUNT(*)
+ FROM {node}
+ WHERE uid = %d
+ AND type IN ($in)", $query_args));
if (module_exists('comment')) {
- $count += db_result(db_query("SELECT COUNT(*) FROM {comments} WHERE uid = %d", $uid));
+ $count += db_result(db_query("SELECT COUNT(*)
+ FROM {comments}
+ WHERE uid = %d", $uid));
}
}
else {
$count = 0;
}
}
- // mysql only query
+ // MySQL only query
db_query("REPLACE INTO {user_titles_posts} (uid, posts) VALUES (%d, %d)", $uid, $count);
return $count;
}
/**
* Get allowed types from db.
+ *
+ * @return
+ * An array of node types that count towards the post count.
*/
function user_titles_get_allowed_types() {
return variable_get('user_titles_types', array());
@@ -696,6 +537,9 @@ function user_titles_get_allowed_types()
/**
* Set allowed types from db
+ *
+ * @param $types
+ * An array of node types that count towards the post count.
*/
function user_titles_set_allowed_types($types) {
variable_set('user_titles_types', $types);
@@ -703,16 +547,23 @@ function user_titles_set_allowed_types($
/**
* Get titles from db
- * If tid is passed in only that title will be fetched, otherwise all titles will be fetched
+ * If tid is passed in only that title will be fetched, otherwise all titles will be fetched.
+ *
+ * @param $tid
+ * The title id to retrieve. If NULL then fetch all titles.
+ *
+ * @return
+ * If $tid param is not NULL a title object is returned.
+ * Otherwise an array of title objects is returned.
*/
function user_titles_get_titles($tid = NULL) {
if ($tid && is_numeric($tid)) {
- $result = db_fetch_array(db_query("SELECT * FROM {user_titles} WHERE tid = %d", $tid));
+ $result = db_fetch_object(db_query("SELECT * FROM {user_titles} WHERE tid = %d", $tid));
}
else {
$result = array();
$query = db_query("SELECT * FROM {user_titles} ORDER BY value DESC");
- while ($row = db_fetch_array($query)) {
+ while ($row = db_fetch_object($query)) {
$result[] = $row;
}
}
@@ -721,77 +572,88 @@ function user_titles_get_titles($tid = N
}
/**
- * Implementation of hook_user()
+ * Get titles from db based on rid
+ * If rid is passed in only that roles titles will be fetched,
+ * otherwise all titles will be fetched and ordered by role then value
*
- * Add the 'edit user title' form to the edit user page.
+ * @param $rid
+ * The role id to get the titles for. If NULL return all titles.
+ *
+ * @return
+ * An array of title objects.
*/
-function user_titles_user($op, $edit, &$user, $category = NULL) {
- switch ($op) {
- case 'form':
- if (user_access('administer user titles') && $category == 'account' && (isset($user->uid))) {
- // when user tries to edit his own data
- $form['user_titles'] = array(
- '#type' => 'fieldset',
- '#title' => t('User Title'),
- '#collapsible' => TRUE,
- '#weight' => 4);
- $title_info = user_titles_get_user_title_info($user);
-
- if (!isset($title_info['title'])) {
- $title = t('No title set');
- }
- else {
- $title = $title_info['title'];
- }
-
- $form['user_titles']['current_title'] = array(
- '#value' => '
'. t('Current user title:') .' '. filter_xss_admin($title) .'
',
- );
+function user_titles_get_titles_by_role($rid = NULL) {
+ $result = array();
+ if ($rid) {
+ $query = db_query("SELECT * FROM {user_titles} WHERE rid = %d ORDER BY value DESC", $rid);
+ }
+ else {
+ $query = db_query("SELECT * FROM {user_titles} ORDER BY rid, value DESC");
+ }
+ while ($row = db_fetch_object($query)) {
+ $result[] = $row;
+ }
+ return $result;
+}
- if (isset($title_info['title']) && empty($title_info['tid'])) {
- $default_title_info = user_titles_get_title(user_titles_get_posts($uid));
- if (!isset($default_title_info['title'])) {
- $default_title = t('No title set');
- }
- else {
- $default_title = $default_title_info['title'];
- }
- $form['user_titles']['default_title'] = array(
- '#value' => '
'. t('Default user title:') .' '. filter_xss_admin($default_title) .'
',
- );
- }
+/**
+ * Get an array of the roles available for user_titles ordered by weight.
+ *
+ * @return
+ * An array of roles with role id as the key and role name as the value.
+ */
+function user_titles_get_roles() {
+ $roles = array();
+ $result = db_query("SELECT r.rid, r.name
+ FROM {role} r, {user_titles_roles} ur
+ WHERE r.rid = ur.rid
+ ORDER BY ur.weight");
+ while ($row = db_fetch_array($result)) {
+ $roles[$row['rid']] = $row['name'];
+ }
+ return $roles;
+}
- $form['user_titles']['user_title'] = array(
- '#type' => 'textfield',
- '#title' => t('Override title'),
- '#description' => t('Enter a title here to give this user a manually overridden title. Leave blank to use the default title.'),
- '#default_value' => isset($user->user_title) ? $user->user_title : '',
- );
+/**
+ * Get the default role in case a role is not specified somewhere.
+ * The default role is the role with the least weight.
+ *
+ * @return
+ * An integer containing a role id.
+ */
+function user_titles_get_default_role() {
+ $rid = db_result(db_query_range("SELECT rid FROM {user_titles_roles} ORDER BY weight", 0, 1));
+ return $rid;
+}
- return $form;
- }
- break;
- case 'delete':
- db_query('DELETE FROM {user_titles_posts} WHERE uid = %d', $user->uid);
- break;
- case 'view':
- $title = user_titles_get_user_title($user);
- if ($title) {
- $user->content['user_titles'] = array(
- '#type' => 'user_profile_category',
- '#title' => t('User title'),
- );
- $user->content['user_titles']['title'] = array(
- '#type' => 'user_profile_item',
- '#value' => filter_xss_admin($title),
- );
- }
- break;
- }
+/**
+ * Get the role that is to be used for a users titles.
+ *
+ * @return
+ * An integer containing a role id.
+ */
+function user_titles_get_users_title_role($uid) {
+ $rid = db_result(db_query_range("SELECT rid
+ FROM {user_titles_roles}
+ WHERE rid IN (2, (SELECT rid
+ FROM {users_roles}
+ WHERE uid = %d))
+ ORDER BY weight", $uid, 0, 1));
+ return $rid;
}
/**
* Theme function for user titles images.
+ *
+ * @param $filepath
+ * A string containing the filepath of the image
+ * @param $alt
+ * A string containing the alt text for the image. Also used for the image title.
+ *
+ * @return
+ * A string containing the html output for the user titles image.
+ *
+ * @ingroup themeable
*/
function theme_user_titles_image($filepath, $alt) {
$image = theme('image', $filepath, $alt, $alt, '', FALSE);
@@ -804,6 +666,22 @@ function theme_user_titles_image($filepa
}
/**
+ * Implementation of template_preprocess_node().
+ */
+function user_titles_preprocess_node(&$variables) {
+ $variables['user_title'] = user_titles_get_user_title($variables['node']->uid);
+ $variables['user_title_image'] = user_titles_get_user_image($variables['node']->uid);
+}
+
+/**
+ * Implementation of template_preprocess_comment().
+ */
+function user_titles_preprocess_comment(&$variables) {
+ $variables['user_title'] = user_titles_get_user_title($variables['comment']->uid);
+ $variables['user_title_image'] = user_titles_get_user_image($variables['comment']->uid);
+}
+
+/**
* Built-in hook implementation that counts nodes
*/
function user_titles_user_titles($op, $uid = NULL) {
@@ -821,94 +699,10 @@ function user_titles_user_titles($op, $u
return;
case 'get':
$res = db_result(db_query("SELECT posts FROM {user_titles_posts} WHERE uid = %d", $uid));
- if ($res === FALSE) $res = user_titles_update_post_count($uid);
- return $res;
- }
-}
-
-/**
- * Sample hook implementation for userpoints; should be placed in userpoints
- */
-if (module_exists('userpoints') && !function_exists('userpoints_user_titles')) {
- function userpoints_user_titles($op, $uid = NULL) {
- switch ($op) {
- case 'register':
- return 'userpoints';
- case 'name':
- return t('User points');
- case 'description':
- return t('Different points values are assigned to user actions');
- case 'units':
- return t('Points');
- case 'url':
- return 'admin/help/userpoints';
- case 'get':
- return userpoints_get_current_points($uid);
- }
- }
-}
-
-/**
- * Implementation of hook_block().
- */
-function user_titles_block($op = 'list', $delta = 0, $edit = array()) {
- switch ($op) {
- case 'list':
- $blocks[0] = array(
- 'info' => t('User Titles: Users with my title'),
- 'cache' => BLOCK_CACHE_PER_USER,
- );
- return $blocks;
- case 'view':
- // If $op is "view", then we need to generate the block for display
- // purposes. The $delta parameter tells us which block is being requested.
- switch ($delta) {
- case 0:
- $block['subject'] = t('Users with your title');
- $block['content'] = user_titles_matching_users_block();
- break;
+ if ($res === FALSE) {
+ $res = user_titles_update_post_count($uid);
}
- return $block;
- }
-
-}
-
-/**
- * Creates the content for a block that lists users with your title
- * Displays 10 random users with the same title as you
- */
-function user_titles_matching_users_block() {
- global $user;
- $users = user_titles_get_matching_users($user->uid);
- if (!empty($users)) {
- shuffle($users);
- $count = min(10, count($users));
- $output = '