api/v3/Constant.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * CiviCRM APIv3 pseudoconstants
  31  *
  32  * @deprecated
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Constant
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: Constant.php 30171 2010-10-14 09:11:27Z mover $
  37  */
  38
  39 /**
  40  * @deprecated api notice
  41  * @return string 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  string  Name of a public static method of
  52  *                  CRM_Core_PseudoConstant: one of
  53  *  <ul>
  54  *    <li>activityStatus</li>
  55  *    <li>activityType</li>
  56  *    <li>addressee</li>
  57  *    <li>allGroup</li>
  58  *    <li>country</li>
  59  *    <li>countryIsoCode</li>
  60  *    <li>county</li>
  61  *    <li>currencyCode</li>
  62  *    <li>currencySymbols</li>
  63  *    <li>customGroup</li>
  64  *    <li>emailGreeting</li>
  65  *    <li>fromEmailAddress</li>
  66  *    <li>gender</li>
  67  *    <li>group</li>
  68  *    <li>groupIterator</li>
  69  *    <li>honor</li>
  70  *    <li>IMProvider</li>
  71  *    <li>individualPrefix</li>
  72  *    <li>individualSuffix</li>
  73  *    <li>locationType</li>
  74  *    <li>locationVcardName</li>
  75  *    <li>mailProtocol</li>
  76  *    <li>mappingTypes</li>
  77  *    <li>paymentProcessor</li>
  78  *    <li>paymentProcessorType</li>
  79  *    <li>pcm</li>
  80  *    <li>phoneType</li>
  81  *    <li>postalGreeting</li>
  82  *    <li>priority</li>
  83  *    <li>relationshipType</li>
  84  *    <li>stateProvince</li>
  85  *    <li>stateProvinceAbbreviation</li>
  86  *    <li>stateProvinceForCountry</li>
  87  *    <li>staticGroup</li>
  88  *    <li>tag</li>
  89  *    <li>tasks</li>
  90  *    <li>ufGroup</li>
  91  *    <li>visibility</li>
  92  *    <li>worldRegion</li>
  93  *    <li>wysiwygEditor</li>
  94  *  </ul>
  95  * @return array
  96  *  @example ConstantGet.php
  97  *  {@getfields constant_get}
  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
 107   // Whitelist approach is safer
 108   $allowedClasses = array(
 109     'CRM_Core_PseudoConstant',
 110     'CRM_Event_PseudoConstant',
 111     'CRM_Contribute_PseudoConstant',
 112     'CRM_Member_PseudoConstant',
 113   );
 114   $className = $allowedClasses[0];
 115   if (!empty($params['class']) && in_array($params['class'], $allowedClasses)) {
 116     $className = $params['class'];
 117   }
 118   $callable = "$className::$name";
 119   if (is_callable($callable)) {
 120     if (empty($params)) {
 121       $values = call_user_func(array($className, $name));
 122     }
 123     else {
 124       $values = call_user_func(array($className, $name));
 125       //@TODO XAV take out the param the COOKIE, Entity, Action and so there are only the "real param" in it
 126       //$values = call_user_func_array( array( $className, $name ), $params );
 127     }
 128     return civicrm_api3_create_success($values, $params, 'constant');
 129   }
 130   else{
 131     $values = call_user_func(array('CRM_Utils_PseudoConstant', 'getConstant'), $name);
 132     if(!empty($values)){
 133       return civicrm_api3_create_success($values, $params, 'constant');
 134     }
 135   }
 136   return civicrm_api3_create_error('Unknown civicrm constant or method not callable');
 137 }
 138
 139 /**
 140  * @param $params
 141  */
 142 function _civicrm_api3_constant_get_spec(&$params) {
 143   $options = array(
 144     'activityStatus',
 145     'activityType',
 146     'addressee',
 147     'allGroup',
 148     'country',
 149     'countryIsoCode',
 150     'county',
 151     'currencyCode',
 152     'currencySymbols',
 153     'customGroup',
 154     'emailGreeting',
 155     'fromEmailAddress',
 156     'gender',
 157     'group',
 158     'groupIterator',
 159     'honor',
 160     'IMProvider',
 161     'individualPrefix',
 162     'individualSuffix',
 163     'locationType',
 164     'locationVcardName',
 165     'mailProtocol',
 166     'mappingTypes',
 167     'paymentInstrument',
 168     'paymentProcessor',
 169     'paymentProcessorType',
 170     'pcm',
 171     'phoneType',
 172     'postalGreeting',
 173     'priority',
 174     'relationshipType',
 175     'stateProvince',
 176     'stateProvinceAbbreviation',
 177     'stateProvinceForCountry',
 178     'staticGroup',
 179     'tag',
 180     'tasks',
 181     'ufGroup',
 182     'visibility',
 183     'worldRegion',
 184     'wysiwygEditor',
 185   );
 186   $params = (array
 187     ('name' => array(
 188       'title' => 'Constant Name',
 189       'name' => 'name',
 190       'api.required' => 1,
 191         'options' => array_combine($options, $options)
 192       ))
 193   );
 194 }
 195