CRM/Admin/Page/JobLog.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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 Classname of BAO.
  53    */
  54   function getBAOName() {
  55     return 'CRM_Core_BAO_Job';
  56   }
  57
  58   /**
  59    * Get action Links
  60    *
  61    * @return array (reference) of action links
  62    */
  63   function &links() {
  64     return self::$_links;
  65   }
  66
  67   /**
  68    * Run the page.
  69    *
  70    * This method is called after the page is created. It checks for the
  71    * type of action and executes that action.
  72    * Finally it calls the parent's run method.
  73    *
  74    * @return void
  75    * @access public
  76    *
  77    */
  78   function run() {
  79     // set title and breadcrumb
  80     CRM_Utils_System::setTitle(ts('Settings - Scheduled Jobs Log'));
  81     $breadCrumb = array(array('title' => ts('Administration'),
  82         'url' => CRM_Utils_System::url('civicrm/admin',
  83           'reset=1'
  84         ),
  85       ));
  86     CRM_Utils_System::appendBreadCrumb($breadCrumb);
  87     return parent::run();
  88   }
  89
  90   /**
  91    * Browse all jobs.
  92    *
  93    * @return void
  94    * @access public
  95    * @static
  96    */
  97   function browse($action = NULL) {
  98
  99     $jid = CRM_Utils_Request::retrieve('jid', 'Positive', $this);
 100
 101     $sj = new CRM_Core_JobManager();
 102
 103     $jobName = NULL;
 104     foreach ($sj->jobs as $i => $job) {
 105       if ($job->id == $jid) {
 106         $jobName = $job->name;
 107       }
 108     }
 109
 110     $this->assign('jobName', $jobName);
 111
 112     $dao = new CRM_Core_DAO_JobLog();
 113     $dao->orderBy('id desc');
 114     if ($jobName) {
 115       $dao->job_id = $jid;
 116     }
 117     $dao->find();
 118     $rows = array();
 119     while ($dao->fetch()) {
 120       unset($row);
 121       CRM_Core_DAO::storeValues($dao, $row);
 122       $rows[$dao->id] = $row;
 123     }
 124     $this->assign('rows', $rows);
 125
 126     $this->assign('jobId', $jid);
 127   }
 128
 129   /**
 130    * Get name of edit form
 131    *
 132    * @return string Classname of edit form.
 133    */
 134   function editForm() {
 135     return 'CRM_Admin_Form_Job';
 136   }
 137
 138   /**
 139    * Get edit form name
 140    *
 141    * @return string name of this page.
 142    */
 143   function editName() {
 144     return 'Scheduled Jobs';
 145   }
 146
 147   /**
 148    * Get user context.
 149    *
 150    * @return string user context.
 151    */
 152   function userContext($mode = NULL) {
 153     return 'civicrm/admin/job';
 154   }
 155 }
 156