CRM/Batch/Page/Batch.php

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