crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Utils/Api.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  * Class CRM_Utils_Api
  30  */
  31 class CRM_Utils_Api {
  32   /**
  33    * Attempts to retrieve the API entity name from any calling class.
  34    * FIXME: This is a bit hackish but the naming convention for forms is not very strict
  35    *
  36    * @param string|object $classNameOrObject
  37    *
  38    * @return string
  39    * @throws CRM_Core_Exception
  40    */
  41   public static function getEntityName($classNameOrObject) {
  42     require_once 'api/api.php';
  43     $className = is_string($classNameOrObject) ? $classNameOrObject : get_class($classNameOrObject);
  44
  45     // First try the obvious replacements
  46     $daoName = str_replace(array('_BAO_', '_Form_', '_Page_'), '_DAO_', $className);
  47     $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($daoName);
  48
  49     // If that didn't work, try a different pattern
  50     if (!$entityName) {
  51       list(, $parent, , $child) = explode('_', $className);
  52       $daoName = "CRM_{$parent}_DAO_$child";
  53       $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($daoName);
  54     }
  55
  56     // If that didn't work, try a different pattern
  57     if (!$entityName) {
  58       $daoName = "CRM_{$parent}_DAO_$parent";
  59       $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($daoName);
  60     }
  61
  62     // If that didn't work, try a different pattern
  63     if (!$entityName) {
  64       $daoName = "CRM_Core_DAO_$child";
  65       $entityName = CRM_Core_DAO_AllCoreTables::getBriefName($daoName);
  66     }
  67
  68     // If that didn't work, try using just the trailing name
  69     if (!$entityName) {
  70       $entityName = CRM_Core_DAO_AllCoreTables::getFullName($child) ? $child : NULL;
  71     }
  72
  73     // If that didn't work, try using just the leading name
  74     if (!$entityName) {
  75       $entityName = CRM_Core_DAO_AllCoreTables::getFullName($parent) ? $parent : NULL;
  76     }
  77
  78     if (!$entityName) {
  79       throw new CRM_Core_Exception('Could not find api name for supplied class');
  80     }
  81     return $entityName;
  82   }
  83
  84 }