CiviCRM Community Forums (archive)

I just installed Zend Studio which is like eclipse on steriods because I wanted to check out the extra functions.

Suddenly my Civi code base was littered with error notices!

The one at the bottom was a pretty good spot - it tells me that  $apiFile is not defined (which is an error for my European A-teamers). It also points out quite a few other things that are quite handy ... like who would have noticed that      $campaignId on line 253 of class CRM_Campaign_Form_Task_Reserve if not defined anywhere if I hadn't looked at my Zend errors


But the most common ones are 'assignment in condition' http://bytes.com/topic/php/answers/876224-assignments-conditions-should-avoided. Is this really something that should be phased out of Civi code?




Error for A-Team $apiFile is not defined
/**
 * @param $entity
 * @param $rest_interface : boolean
 *   In case of TRUE, we need to set the base path explicitly.
 */
function civicrm_api_include($entity, $rest_interface = FALSE) {
  $version = civicrm_get_api_version();
  $camel_name = civicrm_api_get_camel_name($entity);
  $file = 'api/v'. $version .'/'. $camel_name .'.php';
 
  if ( $rest_interface ) {
      $apiPath = substr( $_SERVER['SCRIPT_FILENAME'], 0, -15 );
      // check to ensure file exists, else die
      if ( ! file_exists( $apiPath . $apiFile ) ) {
          return self::error( 'Unknown function invocation.' );
      }
      $file = $apiPath . $file;
  }
 
  require_once $file;
}

Wow, this is embarrassing. What was I thinking?
Probably this was copied/adapted from somewhere else, but still..

There is also this "self::error" which looks wrong in a function context.

For the record, this could be copied from
CRM_Utils_REST::process( &$args, $restInterface = true )

with

        if ( $restInterface ) {
            $apiPath = substr( $_SERVER['SCRIPT_FILENAME'] , 0 ,-15 );
            // check to ensure file exists, else die
            if ( ! file_exists( $apiPath . $apiFile ) ) {
                return self::error( 'Unknown function invocation.' );
            }
        } else {
            $apiPath = null;
        }

(looking at r32131 of trunk)

I should definitely have spent more time on this, or someone else would have needed to have a look after the commit.

Note:
If we get rid of the nameclash problem pointed out in http://forum.civicrm.org/index.php/topic,18712.0.html, a lot of the code in api.php will become obsolete.

I think that eclipse does this error checking too actuallly - but the function rename might be worth paying the ZEND $ for - not sure but I have 57 days to decide