Add financial pseudoconstants CRM-12464

[civicrm-core.git] / CRM / Case / PseudoConstant.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.3                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2013                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2013
 * $Id$
 *
 */

/**
 * This class holds all the Pseudo constants that are specific for CiviCase.
 *
 */
class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant {

  /**
   * case statues
   * @var array
   * @static
   */
  static $caseStatus = array();

  /**
   * redaction rules
   * @var array
   * @static
   */
  static $redactionRule;

  /**
   * case type
   * @var array
   * @static
   */
  static $caseType = array();

  /**
   * Encounter Medium
   * @var array
   * @static
   */
  static $encounterMedium = array();

  /**
   * activity type
   * @var array
   * @static
   */
  static $activityTypeList = array();

  /**
   * case type
   * @var array
   * @static
   */
  static $caseTypePair = array();

  /**
   * Get all the case statues
   *
   * @access public
   *
   * @return array - array reference of all case statues
   * @static
   */
  public static function caseStatus($column = 'label', $onlyActive = TRUE) {
    $cacheKey = "{$column}_" . (int)$onlyActive;
    if (!isset(self::$caseStatus[$cacheKey])) {
      self::$caseStatus[$cacheKey] = CRM_Core_OptionGroup::values('case_status',
        FALSE, FALSE, FALSE, NULL,
        $column, $onlyActive
      );
    }

    return self::$caseStatus[$cacheKey];
  }

  /**
   * Get all the redaction rules
   *
   * @access public
   *
   * @return array - array reference of all redaction rules
   * @static
   */

  public static function redactionRule($filter = NULL) {
    // if ( ! self::$redactionRule ) {
    self::$redactionRule = array();

    if ($filter === 0) {
      $condition = "  AND (v.filter = 0 OR v.filter IS NULL)";
    }
    elseif ($filter === 1) {
      $condition = "  AND  v.filter = 1";
    }
    elseif ($filter === NULL) {
      $condition = NULL;
    }

    self::$redactionRule = CRM_Core_OptionGroup::values('redaction_rule', TRUE, FALSE, FALSE, $condition);
    // }
    return self::$redactionRule;
  }

  /**
   * Get all the case type
   *
   * @access public
   *
   * @return array - array reference of all case type
   * @static
   */
  public static function caseType($column = 'label', $onlyActive = TRUE) {
    $cacheKey = "{$column}_" . (int)$onlyActive;
    if (!isset(self::$caseType[$cacheKey])) {
      self::$caseType[$cacheKey] = CRM_Core_OptionGroup::values('case_type',
        FALSE, FALSE, FALSE, NULL,
        $column, $onlyActive
      );
    }

    return self::$caseType[$cacheKey];
  }

  /**
   * Get all the Encounter Medium
   *
   * @access public
   *
   * @return array - array reference of all Encounter Medium.
   * @static
   */
  public static function encounterMedium($column = 'label', $onlyActive = TRUE) {
    $cacheKey = "{$column}_" . (int)$onlyActive;
    if (!isset(self::$encounterMedium[$cacheKey])) {
      self::$encounterMedium[$cacheKey] = CRM_Core_OptionGroup::values('encounter_medium',
        FALSE, FALSE, FALSE, NULL,
        $column, $onlyActive
      );
    }

    return self::$encounterMedium[$cacheKey];
  }

  /**
   * Get all Activty types for the CiviCase component
   *
   * The static array activityType is returned
   *
   * @param boolean $indexName - true return activity name in array
   * key else activity id as array key.
   *
   * @access public
   * @static
   *
   * @return array - array reference of all activty types.
   */
  public static function &caseActivityType($indexName = TRUE, $all = FALSE) {
    $cache = (int) $indexName . '_' . (int) $all;

    if (!array_key_exists($cache, self::$activityTypeList)) {
      self::$activityTypeList[$cache] = array();

      $query = "
              SELECT  v.label as label ,v.value as value, v.name as name, v.description as description
              FROM   civicrm_option_value v,
                     civicrm_option_group g
              WHERE  v.option_group_id = g.id
                     AND  g.name         = 'activity_type'
                     AND  v.is_active    = 1 
                     AND  g.is_active    = 1";

      if (!$all) {
        $componentId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Component',
          'CiviCase',
          'id', 'name'
        );
        $query .= " AND  v.component_id = {$componentId} ";
      }

      $query .= "  ORDER BY v.weight";

      $dao = CRM_Core_DAO::executeQuery($query);

      $activityTypes = array();
      while ($dao->fetch()) {
        if ($indexName) {
          $index = $dao->name;
        }
        else {
          $index = $dao->value;
        }
        $activityTypes[$index] = array();
        $activityTypes[$index]['id'] = $dao->value;
        $activityTypes[$index]['label'] = $dao->label;
        $activityTypes[$index]['name'] = $dao->name;
        $activityTypes[$index]['description'] = $dao->description;
      }
      self::$activityTypeList[$cache] = $activityTypes;
    }
    return self::$activityTypeList[$cache];
  }

  /**
   * Get the associated case type name/id, given a case Id
   *
   * @access public
   *
   * @return array - array reference of all case type name/id
   * @static
   */
  public static function caseTypeName($caseId, $column = 'name') {
    if (!$caseId) {
      return FALSE;
    }

    if (!array_key_exists($caseId, self::$caseTypePair) || empty(self::$caseTypePair[$caseId][$column])) {
      $caseTypes = self::caseType($column);
      $caseTypeIds = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case',
        $caseId,
        'case_type_id'
      );
      $caseTypeId = explode(CRM_Core_DAO::VALUE_SEPARATOR,
        trim($caseTypeIds,
          CRM_Core_DAO::VALUE_SEPARATOR
        )
      );
      $caseTypeId = $caseTypeId[0];

      self::$caseTypePair[$caseId][$column] = array(
        'id' => $caseTypeId,
        'name' => $caseTypes[$caseTypeId],
      );
    }

    return self::$caseTypePair[$caseId][$column];
  }

  /**
   * Flush given pseudoconstant so it can be reread from db
   * nex time it's requested.
   *
   * @access public
   * @static
   *
   * @param boolean $name pseudoconstant to be flushed
   *
   */
  public static function flush($name) {
   if (isset(self::$$name)) {
      self::$$name = NULL;
    }
  }
}