Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
006389de | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | */ |
33 | ||
34 | ||
35 | /** | |
36 | * Page for displaying list of financial batches | |
37 | */ | |
38 | class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic { | |
39 | /** | |
fe482240 | 40 | * The action links that we need to display for the browse screen. |
6a488035 TO |
41 | * |
42 | * @var array | |
6a488035 | 43 | */ |
045f52a3 | 44 | static $_links = NULL; |
6a488035 TO |
45 | static $_entityID; |
46 | ||
045f52a3 TO |
47 | static $_columnHeader = NULL; |
48 | static $_returnvalues = NULL; | |
353ffa53 | 49 | |
6a488035 | 50 | /** |
fe482240 | 51 | * Get BAO Name. |
6a488035 | 52 | * |
a6c01b45 CW |
53 | * @return string |
54 | * Classname of BAO. | |
6a488035 | 55 | */ |
00be9182 | 56 | public function getBAOName() { |
6a488035 TO |
57 | return 'CRM_Batch_BAO_Batch'; |
58 | } | |
59 | ||
60 | /** | |
fe482240 | 61 | * Get action Links. |
6a488035 | 62 | * |
a6c01b45 CW |
63 | * @return array |
64 | * (reference) of action links | |
6a488035 | 65 | */ |
00be9182 | 66 | public function &links() { |
6a488035 | 67 | if (!(self::$_links)) { |
be2fb01f CW |
68 | self::$_links = [ |
69 | 'view' => [ | |
353ffa53 TO |
70 | 'name' => ts('View'), |
71 | 'url' => 'civicrm/contact/view/contribution', | |
72 | 'qs' => 'reset=1&id=%%contid%%&cid=%%cid%%&action=view&context=contribution&selectedChild=contribute', | |
6a488035 | 73 | 'title' => ts('View Contribution'), |
be2fb01f CW |
74 | ], |
75 | 'remove' => [ | |
353ffa53 | 76 | 'name' => ts('Remove'), |
6a488035 TO |
77 | 'title' => ts('Remove Transaction'), |
78 | 'extra' => 'onclick = "assignRemove( %%id%%,\'' . 'remove' . '\' );"', | |
be2fb01f CW |
79 | ], |
80 | ]; | |
6a488035 TO |
81 | } |
82 | return self::$_links; | |
83 | } | |
84 | ||
85 | /** | |
86 | * Run the page. | |
87 | * | |
88 | * This method is called after the page is created. It checks for the | |
89 | * type of action and executes that action. | |
90 | * Finally it calls the parent's run method. | |
6a488035 | 91 | */ |
00be9182 | 92 | public function run() { |
6a488035 | 93 | // get the requested action |
045f52a3 | 94 | $action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse'); // default to 'browse' |
03e04002 | 95 | |
6a488035 TO |
96 | // assign vars to templates |
97 | $this->assign('action', $action); | |
03e04002 | 98 | |
045f52a3 | 99 | self::$_entityID = CRM_Utils_Request::retrieve('bid', 'Positive'); |
0efdabe7 | 100 | $statusID = NULL; |
6a488035 TO |
101 | if (isset(self::$_entityID)) { |
102 | $statusID = CRM_Core_DAO::getFieldValue('CRM_Batch_BAO_Batch', self::$_entityID, 'status_id'); | |
103 | } | |
acb1052e | 104 | $breadCrumb |
be2fb01f CW |
105 | = [ |
106 | [ | |
6a488035 TO |
107 | 'title' => ts('Accounting Batches'), |
108 | 'url' => CRM_Utils_System::url('civicrm/financial/financialbatches', | |
109 | "reset=1&batchStatus=$statusID"), | |
be2fb01f CW |
110 | ], |
111 | ]; | |
6a488035 TO |
112 | |
113 | CRM_Utils_System::appendBreadCrumb($breadCrumb); | |
114 | $this->edit($action, self::$_entityID); | |
115 | return parent::run(); | |
116 | } | |
117 | ||
6a488035 | 118 | /** |
fe482240 | 119 | * Get name of edit form. |
6a488035 | 120 | * |
a6c01b45 CW |
121 | * @return string |
122 | * Classname of edit form. | |
6a488035 | 123 | */ |
00be9182 | 124 | public function editForm() { |
6a488035 TO |
125 | return 'CRM_Financial_Form_BatchTransaction'; |
126 | } | |
127 | ||
128 | /** | |
fe482240 | 129 | * Get edit form name. |
6a488035 | 130 | * |
a6c01b45 CW |
131 | * @return string |
132 | * name of this page. | |
6a488035 | 133 | */ |
00be9182 | 134 | public function editName() { |
6a488035 TO |
135 | return 'Batch'; |
136 | } | |
137 | ||
138 | /** | |
139 | * Get user context. | |
140 | * | |
dd244018 EM |
141 | * @param null $mode |
142 | * | |
a6c01b45 CW |
143 | * @return string |
144 | * user context. | |
6a488035 | 145 | */ |
045f52a3 | 146 | public function userContext($mode = NULL) { |
6a488035 TO |
147 | return 'civicrm/batchtransaction'; |
148 | } | |
96025800 | 149 | |
6a488035 | 150 | } |