Backporting apiv3

[Eileen]

Currently before I start on any custom code I backport the api v3 which obviously saves me time & the customer money + means the code is future proof. (NB - I have mostly been working on 3.3 installs so haven't tried backporting to older versions than that)

But, I'm not sure how to backport {CRM_api}. I don't use REST much but would be good to know how to backport that too.

To backport apiv3 I :

from the api directory in code base
svn co http://svn.civicrm.org/civicrm/trunk/api/api.php
svn co http://svn.civicrm.org/civicrm/trunk/api/v3

(and then use write code per http://svn.civicrm.org/civicrm/trunk/api/v3/examples)

Xavier - can you please give me the extra steps to backport?

[xavier]

Hi,

If you copy CRM/Core/Smarty/plugins/function.crmAPI.php it should be enough.

For the rest interface, CRM/Utils/REST.php at least, and might be something else too ?

X+

[Eileen]

Just noting that getting this is my 'backport script' (since I seem to be doing it all the time)

Code: [Select]

cd CRM/Core/Smarty/plugins
wget http://svn.civicrm.org/civicrm/trunk/CRM/Core/Smarty/plugins/function.crmAPI.php
cd ../../../..
svn co http://svn.civicrm.org/civicrm/trunk/api/
svn co http://svn.civicrm.org/civicrm/trunk/api/v3
(haven't done REST yet but works a treat otherwise)

[xavier]

REST should be replacing CRM/Utils/REST.php only (haven't tried, if someone tries, please confirm)

[Eileen]

API v3 doco http://wiki.civicrm.org/confluence/display/CRMDOC40/CiviCRM+Public+APIs

[Eileen]

This patch is required to backport to 3.2.5 or earlier

Code: [Select]

Index: CRM/Core/Error.php
===================================================================
--- CRM/Core/Error.php (revision 989)
+++ CRM/Core/Error.php (working copy)
@@ -467,7 +467,14 @@
         $error->_errors = array( ) ;
         $error->_errorsByLevel = array( ) ;
     }
-
+    /* used for the API, rise the exception instead of catching/fatal it */
+    public static function setRaiseException( ) {
+        PEAR::setErrorHandling( PEAR_ERROR_CALLBACK,  array( 'CRM_Core_Error', 'exceptionHandler' ) );
+    }
+   
+    public static function exceptionHandler ($pearError) {
+        throw new PEAR_Exception($pearError->getMessage(),$pearError);   
+    }
     public static function ignoreException( $callback = null ) {
         if ( ! $callback ) {
             $callback = array( 'CRM_Core_Error', 'nullHandler' );


[xavier]

you also need to copy

CRM/Core/DAO/.listAll.php

and if backporting from 4.0.1

CRM/Core/DAO/.permissions.php

[Eileen]

Need this function in CRM/Utils/Hook.php

    /**
     * This hook is called when API permissions are checked (cf. civicrm_api3_api_check_permission()
     * in api/v3/utils.php and _civicrm_api3_permissions() in CRM/Core/DAO/.permissions.php).
     *
     * @param string $entity       the API entity (like contact)
     * @param string $action       the API action (like get)
     * @param array &$params       the API parameters
     * @param array &$permisisons  the associative permissions array (probably to be altered by this hook)
     */
    static function alterAPIPermissions($entity, $action, &$params, &$permissions)
    {
        $config = CRM_Core_Config::singleton();
        require_once(str_replace('_', DIRECTORY_SEPARATOR, $config->userHookClass) . '.php');
        $null =& CRM_Core_DAO::$_nullObject;
        return eval("return {$config->userHookClass}::invoke(4, \$entity, \$action, \$params, \$permissions, \$null, 'civicrm_alterAPIPermissions');");
    }