BeBot Standard Return Array

BeBot Standard Return Array

Many BeBot functions return an array with a standard format. There is currently no policy that module developers follow this format when their function(s) return data.

Return Array Elements

There are three elements in a BeBot Standard Return Array: bool error, string errordesc, and mixed content.

$return = array('error' => FALSE, 'errordesc' => , 'content' => );

Example Usage

function return_parameter($parameter) {

   $return['error'] = FALSE;
   $return['errordesc'] = ;
   $return['content'];
   if (is_null($parameter))
   {
       $return['error'] = TRUE;
       $return['errordesc'] = 'parameter passed to function return_parameter is null.';
   }
   else
   {
       $return['content'] = $parameter;
   }

}

function calling_function($input) {

   $result = $this -> return_parameter($input);
   if ($result['error'])
   {
       return $result['errordesc'];
   }
   else
   {
       return $result['content'];
   }

}