CRM/Queue/BAO/QueueItem.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  * Helpers for managing SQL-backed queue items
  38  *
  39  * @see CRM_Queue_Queue_Sql
  40  */
  41 class CRM_Queue_BAO_QueueItem extends CRM_Queue_DAO_QueueItem {
  42
  43   /**
  44    * Ensure that the required SQL table exists.
  45    *
  46    * @return bool
  47    *   TRUE if table now exists
  48    */
  49   public static function findCreateTable() {
  50     $checkTableSql = "show tables like 'civicrm_queue_item'";
  51     $foundName = CRM_Core_DAO::singleValueQuery($checkTableSql);
  52     if ($foundName == 'civicrm_queue_item') {
  53       return TRUE;
  54     }
  55
  56     // civicrm/sql/civicrm_queue_item.mysql
  57     $fileName = dirname(__FILE__) . '/../../../sql/civicrm_queue_item.mysql';
  58
  59     $config = CRM_Core_Config::singleton();
  60     CRM_Utils_File::sourceSQLFile($config->dsn, $fileName);
  61
  62     // Make sure it succeeded
  63     $foundName = CRM_Core_DAO::singleValueQuery($checkTableSql);
  64     return ($foundName == 'civicrm_queue_item');
  65   }
  66
  67 }