CRM/Batch/Page/Batch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 current batches
  38  */
  39 class CRM_Batch_Page_Batch 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_Batch_BAO_Batch';
  56   }
  57
  58   /**
  59    * Get action Links
  60    *
  61    * @return array (reference) of action links
  62    */
  63   function &links() {}
  64
  65   /**
  66    * Get name of edit form
  67    *
  68    * @return string Classname of edit form.
  69    */
  70   function editForm() {
  71     return 'CRM_Batch_Form_Batch';
  72   }
  73
  74   /**
  75    * Get edit form name
  76    *
  77    * @return string name of this page.
  78    */
  79   function editName() {
  80     return ts('Batch Processing');
  81   }
  82
  83   /**
  84    * Get user context.
  85    *
  86    * @return string user context.
  87    */
  88   function userContext($mode = NULL) {
  89     return CRM_Utils_System::currentPath();
  90   }
  91
  92   /**
  93    * browse all entities.
  94    *
  95    * @param int $action
  96    *
  97    * @return void
  98    * @access public
  99    */
 100   function browse() {
 101     $status = CRM_Utils_Request::retrieve('status', 'Positive', CRM_Core_DAO::$_nullObject, FALSE, 1);
 102     $this->assign('status', $status);
 103     $this->search();
 104   }
 105
 106   function search() {
 107     if ($this->_action &
 108       (CRM_Core_Action::ADD |
 109         CRM_Core_Action::UPDATE |
 110         CRM_Core_Action::DELETE
 111       )
 112     ) {
 113       return;
 114     }
 115
 116     $form = new CRM_Core_Controller_Simple('CRM_Batch_Form_Search', ts('Search Batches'), CRM_Core_Action::ADD);
 117     $form->setEmbedded(TRUE);
 118     $form->setParent($this);
 119     $form->process();
 120     $form->run();
 121   }
 122 }
 123