api/v3/Constant.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  * CiviCRM APIv3 pseudoconstants
  30  *
  31  * @deprecated
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Constant
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Constant.php 30171 2010-10-14 09:11:27Z mover $
  36  */
  37
  38 /**
  39  * @deprecated api notice
  40  * @return string
  41  *   to indicate this entire api entity is deprecated
  42  */
  43 function _civicrm_api3_constant_deprecation() {
  44   return 'The constant api is deprecated as of CiviCRM 4.4. Please use the getoptions api action instead.';
  45 }
  46
  47 /**
  48  * @deprecated as of CiviCRM 4.4.
  49  * It's recommended to use the api getoptions action instead
  50  *
  51  * @param array $params
  52  *  Name of a public static method of
  53  *                  CRM_Core_PseudoConstant: one of
  54  *  <ul>
  55  *    <li>activityStatus</li>
  56  *    <li>activityType</li>
  57  *    <li>addressee</li>
  58  *    <li>allGroup</li>
  59  *    <li>country</li>
  60  *    <li>countryIsoCode</li>
  61  *    <li>county</li>
  62  *    <li>currencyCode</li>
  63  *    <li>currencySymbols</li>
  64  *    <li>customGroup</li>
  65  *    <li>emailGreeting</li>
  66  *    <li>fromEmailAddress</li>
  67  *    <li>gender</li>
  68  *    <li>group</li>
  69  *    <li>groupIterator</li>
  70  *    <li>honor</li>
  71  *    <li>IMProvider</li>
  72  *    <li>individualPrefix</li>
  73  *    <li>individualSuffix</li>
  74  *    <li>locationType</li>
  75  *    <li>locationVcardName</li>
  76  *    <li>mailProtocol</li>
  77  *    <li>mappingTypes</li>
  78  *    <li>paymentProcessor</li>
  79  *    <li>paymentProcessorType</li>
  80  *    <li>pcm</li>
  81  *    <li>phoneType</li>
  82  *    <li>postalGreeting</li>
  83  *    <li>priority</li>
  84  *    <li>relationshipType</li>
  85  *    <li>stateProvince</li>
  86  *    <li>stateProvinceAbbreviation</li>
  87  *    <li>stateProvinceForCountry</li>
  88  *    <li>staticGroup</li>
  89  *    <li>tag</li>
  90  *    <li>tasks</li>
  91  *    <li>ufGroup</li>
  92  *    <li>visibility</li>
  93  *    <li>worldRegion</li>
  94  *    <li>wysiwygEditor</li>
  95  *  </ul>
  96  *
  97  * @return array
  98  */
  99 function civicrm_api3_constant_get($params) {
 100
 101   $name = $params['name'];
 102   // all the stuff about classes should be adequately replaced by the bit in the 'else'
 103   //ie $values = call_user_func(array('CRM_Utils_PseudoConstant', 'getConstant'), $name);
 104   // once tests are 100% can try removing the first block & a similar block from Generic:getoptions
 105
 106   // Whitelist approach is safer
 107   $allowedClasses = array(
 108     'CRM_Core_PseudoConstant',
 109     'CRM_Event_PseudoConstant',
 110     'CRM_Contribute_PseudoConstant',
 111     'CRM_Member_PseudoConstant',
 112   );
 113   $className = $allowedClasses[0];
 114   if (!empty($params['class']) && in_array($params['class'], $allowedClasses)) {
 115     $className = $params['class'];
 116   }
 117   $callable = "$className::$name";
 118   if (is_callable($callable)) {
 119     if (empty($params)) {
 120       $values = call_user_func(array($className, $name));
 121     }
 122     else {
 123       $values = call_user_func(array($className, $name));
 124       //@TODO XAV take out the param the COOKIE, Entity, Action and so there are only the "real param" in it
 125       //$values = call_user_func_array( array( $className, $name ), $params );
 126     }
 127     return civicrm_api3_create_success($values, $params, 'constant');
 128   }
 129   else {
 130     $values = call_user_func(array('CRM_Utils_PseudoConstant', 'getConstant'), $name);
 131     if (!empty($values)) {
 132       return civicrm_api3_create_success($values, $params, 'constant');
 133     }
 134   }
 135   return civicrm_api3_create_error('Unknown civicrm constant or method not callable');
 136 }
 137
 138 /**
 139  * @param array $params
 140  */
 141 function _civicrm_api3_constant_get_spec(&$params) {
 142   $options = array(
 143     'activityStatus',
 144     'activityType',
 145     'addressee',
 146     'allGroup',
 147     'country',
 148     'countryIsoCode',
 149     'county',
 150     'currencyCode',
 151     'currencySymbols',
 152     'customGroup',
 153     'emailGreeting',
 154     'fromEmailAddress',
 155     'gender',
 156     'group',
 157     'groupIterator',
 158     'honor',
 159     'IMProvider',
 160     'individualPrefix',
 161     'individualSuffix',
 162     'locationType',
 163     'locationVcardName',
 164     'mailProtocol',
 165     'mappingTypes',
 166     'paymentInstrument',
 167     'paymentProcessor',
 168     'paymentProcessorType',
 169     'pcm',
 170     'phoneType',
 171     'postalGreeting',
 172     'priority',
 173     'relationshipType',
 174     'stateProvince',
 175     'stateProvinceAbbreviation',
 176     'stateProvinceForCountry',
 177     'staticGroup',
 178     'tag',
 179     'tasks',
 180     'ufGroup',
 181     'visibility',
 182     'worldRegion',
 183     'wysiwygEditor',
 184   );
 185   $params = array(
 186     'name' => array(
 187       'title' => 'Constant Name',
 188       'name' => 'name',
 189       'api.required' => 1,
 190       'options' => array_combine($options, $options),
 191     ),
 192   );
 193 }