crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Admin/Page/JobLog.php

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