CRM/Utils/Api.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 class CRM_Utils_Api {
  29   /**
  30    * Attempt to retrieve the api entity name from any calling class
  31    * @param $classNameOrObject
  32    * @throws CRM_Core_Exception
  33    */
  34   static function getEntityName($classNameOrObject) {
  35     require_once 'api/api.php';
  36     $className = is_string($classNameOrObject) ? $classNameOrObject : get_class($classNameOrObject);
  37
  38     // First try the obvious replacements
  39     $daoName = str_replace(array('_BAO_', '_Form_', '_Page_'), '_DAO_', $className);
  40     $shortName = CRM_Core_DAO_AllCoreTables::getBriefName($daoName);
  41
  42     // If that didn't work, try a different pattern
  43     if (!$shortName) {
  44       list(, $entity) = explode('_', $className);
  45       $daoName = "CRM_{$entity}_DAO_$entity";
  46       $shortName = CRM_Core_DAO_AllCoreTables::getBriefName($daoName);
  47     }
  48
  49     // If that didn't work, try a different pattern
  50     if (!$shortName) {
  51       list(, , , $entity) = explode('_', $className);
  52       $daoName = "CRM_Core_DAO_$entity";
  53       $shortName = CRM_Core_DAO_AllCoreTables::getBriefName($daoName);
  54     }
  55     if (!$shortName) {
  56       throw new CRM_Core_Exception('Could not find api name for supplied class');
  57     }
  58     return _civicrm_api_get_entity_name_from_camel($shortName);
  59   }
  60 }