CRM/Admin/Page/JobLog.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 jobs
  38  */
  39 class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic {
  40
  41   /**
  42    * The action links that we need to display for the browse screen
  43    *
  44    * @var array
  45    * @static
  46    */
  47   static $_links = NULL;
  48
  49   /**
  50    * Get BAO Name
  51    *
  52    * @return string
  53    *   Classname of BAO.
  54    */
  55   public function getBAOName() {
  56     return 'CRM_Core_BAO_Job';
  57   }
  58
  59   /**
  60    * Get action Links
  61    *
  62    * @return array
  63    *   (reference) of action links
  64    */
  65   public function &links() {
  66     return self::$_links;
  67   }
  68
  69   /**
  70    * Run the page.
  71    *
  72    * This method is called after the page is created. It checks for the
  73    * type of action and executes that action.
  74    * Finally it calls the parent's run method.
  75    *
  76    * @return void
  77    */
  78   public function run() {
  79     // set title and breadcrumb
  80     CRM_Utils_System::setTitle(ts('Settings - Scheduled Jobs Log'));
  81     $breadCrumb = array(
  82       array(
  83         'title' => ts('Administration'),
  84         'url' => CRM_Utils_System::url('civicrm/admin',
  85           'reset=1'
  86         ),
  87       )
  88     );
  89     CRM_Utils_System::appendBreadCrumb($breadCrumb);
  90     return parent::run();
  91   }
  92
  93   /**
  94    * Browse all jobs.
  95    *
  96    * @param null $action
  97    *
  98    * @return void
  99    * @static
 100    */
 101   public function browse($action = NULL) {
 102
 103     $jid = CRM_Utils_Request::retrieve('jid', 'Positive', $this);
 104
 105     $sj = new CRM_Core_JobManager();
 106
 107     $jobName = NULL;
 108     if ($jid) {
 109       $jobName =
 110         CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Job', $jid);
 111     }
 112
 113     $this->assign('jobName', $jobName);
 114
 115     $dao = new CRM_Core_DAO_JobLog();
 116     $dao->orderBy('id desc');
 117
 118     // limit to last 1000 records
 119     $dao->limit(1000);
 120
 121     if ($jid) {
 122       $dao->job_id = $jid;
 123     }
 124     $dao->find();
 125
 126     $rows = array();
 127     while ($dao->fetch()) {
 128       unset($row);
 129       CRM_Core_DAO::storeValues($dao, $row);
 130       $rows[$dao->id] = $row;
 131     }
 132     $this->assign('rows', $rows);
 133
 134     $this->assign('jobId', $jid);
 135   }
 136
 137   /**
 138    * Get name of edit form
 139    *
 140    * @return string
 141    *   Classname of edit form.
 142    */
 143   public function editForm() {
 144     return 'CRM_Admin_Form_Job';
 145   }
 146
 147   /**
 148    * Get edit form name
 149    *
 150    * @return string
 151    *   name of this page.
 152    */
 153   public function editName() {
 154     return 'Scheduled Jobs';
 155   }
 156
 157   /**
 158    * Get user context.
 159    *
 160    * @param null $mode
 161    *
 162    * @return string
 163    *   user context.
 164    */
 165   public function userContext($mode = NULL) {
 166     return 'civicrm/admin/job';
 167   }
 168 }