3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * Page for displaying list of jobs
39 class CRM_Admin_Page_Job
extends CRM_Core_Page_Basic
{
42 * The action links that we need to display for the browse screen
47 static $_links = NULL;
52 * @return string Classname of BAO.
54 function getBAOName() {
55 return 'CRM_Core_BAO_Job';
61 * @return array (reference) of action links
64 if (!(self
::$_links)) {
65 self
::$_links = array(
66 CRM_Core_Action
::FOLLOWUP
=> array(
67 'name' => ts('View Job Log'),
68 'url' => 'civicrm/admin/joblog',
69 'qs' => 'jid=%%id%%&reset=1',
70 'title' => ts('See log entries for this Scheduled Job'),
72 CRM_Core_Action
::UPDATE
=> array(
74 'url' => 'civicrm/admin/job',
75 'qs' => 'action=update&id=%%id%%&reset=1',
76 'title' => ts('Edit Scheduled Job'),
78 CRM_Core_Action
::EXPORT
=> array(
79 'name' => ts('Execute Now'),
80 'url' => 'civicrm/admin/job',
81 'qs' => 'action=export&id=%%id%%&reset=1',
82 'title' => ts('Execute Scheduled Job Now'),
84 CRM_Core_Action
::DISABLE
=> array(
85 'name' => ts('Disable'),
86 'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Core_BAO_Job' . '\',\'' . 'enable-disable' . '\' );"',
87 'ref' => 'disable-action',
88 'title' => ts('Disable Scheduled Job'),
90 CRM_Core_Action
::ENABLE
=> array(
91 'name' => ts('Enable'),
92 'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Core_BAO_Job' . '\',\'' . 'disable-enable' . '\' );"',
93 'ref' => 'enable-action',
94 'title' => ts('Enable Scheduled Job'),
96 CRM_Core_Action
::DELETE
=> array(
97 'name' => ts('Delete'),
98 'url' => 'civicrm/admin/job',
99 'qs' => 'action=delete&id=%%id%%',
100 'title' => ts('Delete Scheduled Job'),
104 return self
::$_links;
110 * This method is called after the page is created. It checks for the
111 * type of action and executes that action.
112 * Finally it calls the parent's run method.
119 // set title and breadcrumb
120 CRM_Utils_System
::setTitle(ts('Settings - Scheduled Jobs'));
121 $breadCrumb = array(array('title' => ts('Scheduled Jobs'),
122 'url' => CRM_Utils_System
::url('civicrm/admin',
126 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
128 $this->_id
= CRM_Utils_Request
::retrieve('id', 'String',
131 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String',
135 if ($this->_action
== 'export') {
136 $session = CRM_Core_Session
::singleton();
137 $session->pushUserContext(CRM_Utils_System
::url('civicrm/admin/job', 'reset=1'));
141 return parent
::run();
151 function browse($action = NULL) {
153 // using Export action for Execute. Doh.
154 if ($this->_action
& CRM_Core_Action
::EXPORT
) {
155 $jm = new CRM_Core_JobManager();
156 $jm->executeJobById($this->_id
);
158 CRM_Core_Session
::setStatus(ts('Selected Scheduled Job has been executed. See the log for details.'), ts("Executed"), "success");
161 $sj = new CRM_Core_JobManager();
162 $rows = $temp = array();
163 foreach ($sj->jobs
as $job) {
164 $action = array_sum(array_keys($this->links()));
166 // update enable/disable links.
167 // CRM-9868- remove enable action for jobs that should never be run automatically via execute action or runjobs url
168 if ($job->api_action
== 'process_membership_reminder_date' ||
$job->api_action
== 'update_greeting') {
169 $action -= CRM_Core_Action
::ENABLE
;
170 $action -= CRM_Core_Action
::DISABLE
;
172 elseif ($job->is_active
) {
173 $action -= CRM_Core_Action
::ENABLE
;
176 $action -= CRM_Core_Action
::DISABLE
;
179 $job->action
= CRM_Core_Action
::formLink(self
::links(), $action,
180 array('id' => $job->id
)
182 $rows[] = get_object_vars($job);
184 $this->assign('rows', $rows);
188 * Get name of edit form
190 * @return string Classname of edit form.
192 function editForm() {
193 return 'CRM_Admin_Form_Job';
199 * @return string name of this page.
201 function editName() {
202 return 'Scheduled Jobs';
208 * @return string user context.
210 function userContext($mode = NULL) {
211 return 'civicrm/admin/job';