CRM/Financial/Page/FinancialType.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.6                                                |
   5   +--------------------------------------------------------------------+
   6   | Copyright CiviCRM LLC (c) 2004-2014                                |
   7   +--------------------------------------------------------------------+
   8   | This file is a part of CiviCRM.                                    |
   9   |                                                                    |
  10   | CiviCRM is free software; you can copy, modify, and distribute it  |
  11   | under the terms of the GNU Affero General Public License           |
  12   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13   |                                                                    |
  14   | CiviCRM is distributed in the hope that it will be useful, but     |
  15   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17   | See the GNU Affero General Public License for more details.        |
  18   |                                                                    |
  19   | You should have received a copy of the GNU Affero General Public   |
  20   | License and the CiviCRM Licensing Exception along                  |
  21   | with this program; if not, contact CiviCRM LLC                     |
  22   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23   | GNU Affero General Public License or the licensing of CiviCRM,     |
  24   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25   +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Page for displaying list of financial types
  38  */
  39 class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic {
  40
  41   public $useLivePageJS = TRUE;
  42   /**
  43    * The action links that we need to display for the browse screen
  44    *
  45    * @var array
  46    * @static
  47    */
  48   static $_links = NULL;
  49
  50   /**
  51    * Get BAO Name
  52    *
  53    * @return string
  54    *   Classname of BAO.
  55    */
  56   public function getBAOName() {
  57     return 'CRM_Financial_BAO_FinancialType';
  58   }
  59
  60   /**
  61    * Get action Links
  62    *
  63    * @return array
  64    *   (reference) of action links
  65    */
  66   public function &links() {
  67     if (!(self::$_links)) {
  68       self::$_links = array(
  69         CRM_Core_Action::BROWSE  => array(
  70           'name'  => ts('Accounts'),
  71           'url'   => 'civicrm/admin/financial/financialType/accounts',
  72           'qs'    => 'reset=1&action=browse&aid=%%id%%',
  73           'title' => ts('Accounts'),
  74         ),
  75         CRM_Core_Action::UPDATE  => array(
  76           'name'  => ts('Edit'),
  77           'url'   => 'civicrm/admin/financial/financialType',
  78           'qs'    => 'action=update&id=%%id%%&reset=1',
  79           'title' => ts('Edit Financial Type'),
  80         ),
  81         CRM_Core_Action::DISABLE => array(
  82           'name'  => ts('Disable'),
  83           'ref'   => 'crm-enable-disable',
  84           'title' => ts('Disable Financial Type'),
  85         ),
  86         CRM_Core_Action::ENABLE  => array(
  87           'name'  => ts('Enable'),
  88           'ref'   => 'crm-enable-disable',
  89           'title' => ts('Enable Financial Type'),
  90         ),
  91         CRM_Core_Action::DELETE  => array(
  92           'name'  => ts('Delete'),
  93           'url'   => 'civicrm/admin/financial/financialType',
  94           'qs'    => 'action=delete&id=%%id%%',
  95           'title' => ts('Delete Financial Type'),
  96         ),
  97       );
  98     }
  99     return self::$_links;
 100   }
 101
 102   /**
 103    * Run the page.
 104    *
 105    * This method is called after the page is created. It checks for the
 106    * type of action and executes that action.
 107    * Finally it calls the parent's run method.
 108    *
 109    * @return void
 110    *
 111    */
 112   public function run() {
 113     // get the requested action
 114     $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); // default to 'browse'
 115
 116     // assign vars to templates
 117     $this->assign('action', $action);
 118     $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
 119
 120     // what action to take ?
 121     if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD)) {
 122       $this->edit($action, $id);
 123     }
 124
 125     // parent run
 126     return parent::run();
 127   }
 128
 129   /**
 130    * Browse all financial types
 131    *
 132    *
 133    * @return void
 134    * @static
 135    */
 136   public function browse() {
 137     // get all financial types sorted by weight
 138     $financialType = array();
 139     $dao = new CRM_Financial_DAO_FinancialType();
 140     $dao->orderBy('name');
 141     $dao->find();
 142
 143     while ($dao->fetch()) {
 144       $financialType[$dao->id] = array();
 145       CRM_Core_DAO::storeValues($dao, $financialType[$dao->id]);
 146       $defaults = $financialAccountId = array();
 147       $financialAccounts = CRM_Contribute_PseudoConstant::financialAccount();
 148       $financialAccountIds = array();
 149
 150       $params['entity_id'] = $dao->id;
 151       $params['entity_table'] = 'civicrm_financial_type';
 152       CRM_Financial_BAO_FinancialTypeAccount::retrieve($params, CRM_Core_DAO::$_nullArray, $financialAccountIds);
 153
 154       foreach ($financialAccountIds as $key => $values) {
 155         if (!empty($financialAccounts[$values['financial_account_id']])) {
 156           $financialAccountId[$values['financial_account_id']] = CRM_Utils_Array::value(
 157             $values['financial_account_id'], $financialAccounts);
 158         }
 159       }
 160
 161       if (!empty($financialAccountId)) {
 162         $financialType[$dao->id]['financial_account'] = implode(',', $financialAccountId);
 163       }
 164
 165       // form all action links
 166       $action = array_sum(array_keys($this->links()));
 167
 168       // update enable/disable links depending on if it is is_reserved or is_active
 169       if ($dao->is_reserved) {
 170         $action -= CRM_Core_Action::ENABLE;
 171         $action -= CRM_Core_Action::DISABLE;
 172         $action -= CRM_Core_Action::DELETE;
 173         //continue;
 174       }
 175       else {
 176         if ($dao->is_active) {
 177           $action -= CRM_Core_Action::ENABLE;
 178         }
 179         else {
 180           $action -= CRM_Core_Action::DISABLE;
 181         }
 182       }
 183
 184       $financialType[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 185         array('id' => $dao->id),
 186         ts('more'),
 187         FALSE,
 188         'financialType.manage.action',
 189         'FinancialType',
 190         $dao->id
 191       );
 192     }
 193     $this->assign('rows', $financialType);
 194   }
 195
 196   /**
 197    * Get name of edit form
 198    *
 199    * @return string
 200    *   Classname of edit form.
 201    */
 202   public function editForm() {
 203     return 'CRM_Financial_Form_FinancialType';
 204   }
 205
 206   /**
 207    * Get edit form name
 208    *
 209    * @return string
 210    *   name of this page.
 211    */
 212   public function editName() {
 213     return 'Financial Types';
 214   }
 215
 216   /**
 217    * Get user context.
 218    *
 219    * @param null $mode
 220    *
 221    * @return string
 222    *   user context.
 223    */
 224   public function userContext($mode = NULL) {
 225     return 'civicrm/admin/financial/financialType';
 226   }
 227 }