answers.lock.inc in Answers 6.2

Question locking functions for the 'Answers' module

@author Chip Cleary

File

includes/answers.lock.inc

<?php

/**
 * @file
 * Question locking functions for the 'Answers' module
 *
 * @author Chip Cleary
 *
 */

/*
 * The Answers module allow questions to be "locked", meaning that users are no longer permitted to
 * provide new answers to them.
 *
 * The logic about *which* questions to lock may be set by developers or by other modules. For example,
 * the Best Answer module locks questions after a Best Answer is selected while the (under construction)
 * Expire Questions module locks questions after they have passed an expiration date.
 *
 * To support locking, this file provides a hook and some utility functions.
 *
 * The hook:
 *   - hook_answers_lock_question_p: Modules that want to set or release locks should define this hook. It returns TRUE
 *     if a question should be locked.
 */

/**
 * Cycle through all questions and reset their locks.
 *
 * This can be required when a global policy is changed. For example, an
 * administrator may change the policy in the Best Answers module to
 * lock questions after a Best Answer is selected. When this happens,
 * the module calls this function to update the locks.
 */
function answers_reset_question_locks() {
  $modules = module_implements('answers_lock_question_p');
  $query = db_query("SELECT * from {node} WHERE type = 'question';");
  while ($question = db_fetch_object($query)) {
    $question = node_load($question->nid);
    if (answers_lock_question_p($question, $modules)) {
      answers_lock_question($question);
    }
    else {
      answers_unlock_question($question);
    }
  }
}

/**
 * Reset the question lock for a single question
 */
function answers_reset_question_lock($question) {
  $modules = module_implements('answers_lock_question_p');
  if (answers_lock_question_p($question, $modules)) {
    answers_lock_question($question);
  }
  else {
    answers_unlock_question($question);
  }
}

/**
 * Determines if a question should be locked or not.
 *
 * @param $question
 *   A fully loaded question node.
 * @param $modules
 *   What modules to test.
 *
 * @return
 *   Returns TRUE if question should be locked, FALSE otherwise.
 */
function answers_lock_question_p($question, $modules = NULL) {
  if (!$modules) {
    $modules = module_implements('answers_lock_question_p');
  }
  foreach ($modules as $module) {
    if (module_invoke($module, 'answers_lock_question_p', $question)) {
      return TRUE;
    }
  }
  return FALSE;
}

/**
 * Lock a question.
 *
 * @param $question
 *   A fully loaded question node.
 */
function answers_lock_question($question) {
  $question->field_question_locked_p[0]['value'] = TRUE;
  node_save($question);
}

/**
 * Unlock a question.
 *
 * @param $question
 *   A fully loaded question node.
 */
function answers_unlock_question($question) {
  $question->field_question_locked_p[0]['value'] = FALSE;
  node_save($question);
}

Functions

Name	Description
answers_lock_question	Lock a question.
answers_lock_question_p	Determines if a question should be locked or not.
answers_reset_question_lock	Reset the question lock for a single question
answers_reset_question_locks	Cycle through all questions and reset their locks.
answers_unlock_question	Unlock a question.