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