CRM/Financial/Page/FinancialType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Page for displaying list of financial types
  20  */
  21 class CRM_Financial_Page_FinancialType extends CRM_Core_Page_Basic {
  22
  23   public $useLivePageJS = TRUE;
  24   /**
  25    * The action links that we need to display for the browse screen.
  26    *
  27    * @var array
  28    */
  29   public static $_links = NULL;
  30
  31   /**
  32    * Get BAO Name.
  33    *
  34    * @return string
  35    *   Classname of BAO.
  36    */
  37   public function getBAOName() {
  38     return 'CRM_Financial_BAO_FinancialType';
  39   }
  40
  41   /**
  42    * Get action Links.
  43    *
  44    * @return array
  45    *   (reference) of action links
  46    */
  47   public function &links() {
  48     if (!(self::$_links)) {
  49       self::$_links = [
  50         CRM_Core_Action::BROWSE => [
  51           'name' => ts('Accounts'),
  52           'url' => 'civicrm/admin/financial/financialType/accounts',
  53           'qs' => 'reset=1&action=browse&aid=%%id%%',
  54           'title' => ts('Accounts'),
  55         ],
  56         CRM_Core_Action::UPDATE => [
  57           'name' => ts('Edit'),
  58           'url' => 'civicrm/admin/financial/financialType',
  59           'qs' => 'action=update&id=%%id%%&reset=1',
  60           'title' => ts('Edit Financial Type'),
  61         ],
  62         CRM_Core_Action::DISABLE => [
  63           'name' => ts('Disable'),
  64           'ref' => 'crm-enable-disable',
  65           'title' => ts('Disable Financial Type'),
  66         ],
  67         CRM_Core_Action::ENABLE => [
  68           'name' => ts('Enable'),
  69           'ref' => 'crm-enable-disable',
  70           'title' => ts('Enable Financial Type'),
  71         ],
  72         CRM_Core_Action::DELETE => [
  73           'name' => ts('Delete'),
  74           'url' => 'civicrm/admin/financial/financialType',
  75           'qs' => 'action=delete&id=%%id%%',
  76           'title' => ts('Delete Financial Type'),
  77         ],
  78       ];
  79     }
  80     return self::$_links;
  81   }
  82
  83   /**
  84    * Browse all financial types.
  85    */
  86   public function browse() {
  87     // get all financial types sorted by weight
  88     $financialType = [];
  89     $dao = new CRM_Financial_DAO_FinancialType();
  90     $dao->orderBy('name');
  91     $dao->find();
  92
  93     while ($dao->fetch()) {
  94       $financialType[$dao->id] = [];
  95       CRM_Core_DAO::storeValues($dao, $financialType[$dao->id]);
  96       $defaults = $financialAccountId = [];
  97       $financialAccounts = CRM_Contribute_PseudoConstant::financialAccount();
  98       $financialAccountIds = [];
  99
 100       $params['entity_id'] = $dao->id;
 101       $params['entity_table'] = 'civicrm_financial_type';
 102       $null = [];
 103       CRM_Financial_BAO_FinancialTypeAccount::retrieve($params, $null, $financialAccountIds);
 104
 105       foreach ($financialAccountIds as $key => $values) {
 106         if (!empty($financialAccounts[$values['financial_account_id']])) {
 107           $financialAccountId[$values['financial_account_id']] = $financialAccounts[$values['financial_account_id']] ?? NULL;
 108         }
 109       }
 110
 111       if (!empty($financialAccountId)) {
 112         $financialType[$dao->id]['financial_account'] = implode(',', $financialAccountId);
 113       }
 114
 115       // form all action links
 116       $action = array_sum(array_keys($this->links()));
 117
 118       // update enable/disable links depending on if it is is_reserved or is_active
 119       if ($dao->is_reserved) {
 120         $action -= CRM_Core_Action::ENABLE;
 121         $action -= CRM_Core_Action::DISABLE;
 122         $action -= CRM_Core_Action::DELETE;
 123       }
 124       else {
 125         if ($dao->is_active) {
 126           $action -= CRM_Core_Action::ENABLE;
 127         }
 128         else {
 129           $action -= CRM_Core_Action::DISABLE;
 130         }
 131       }
 132
 133       $financialType[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 134         ['id' => $dao->id],
 135         ts('more'),
 136         FALSE,
 137         'financialType.manage.action',
 138         'FinancialType',
 139         $dao->id
 140       );
 141     }
 142     $this->assign('rows', $financialType);
 143   }
 144
 145   /**
 146    * Get name of edit form.
 147    *
 148    * @return string
 149    *   Classname of edit form.
 150    */
 151   public function editForm() {
 152     return 'CRM_Financial_Form_FinancialType';
 153   }
 154
 155   /**
 156    * Get edit form name.
 157    *
 158    * @return string
 159    *   name of this page.
 160    */
 161   public function editName() {
 162     return 'Financial Types';
 163   }
 164
 165   /**
 166    * Get user context.
 167    *
 168    * @param null $mode
 169    *
 170    * @return string
 171    *   user context.
 172    */
 173   public function userContext($mode = NULL) {
 174     return 'civicrm/admin/financial/financialType';
 175   }
 176
 177 }