[civicrm-core.git] / api / Wrapper.php

<?php

/**
 * Interface API_Wrapper
 */
interface API_Wrapper {

  /**
   * Interface for interpreting api input.
   *
   * @param array $apiRequest
   *
   * @return array
   *   modified $apiRequest
   */
  public function fromApiInput($apiRequest);

  /**
   * Interface for interpreting api output.
   *
   * @param array $apiRequest
   * @param array $result
   *
   * @return array
   *   modified $result
   */
  public function toApiOutput($apiRequest, $result);

}
Commit	Line	Data
6a488035 TO	1	<?php
6a488035 TO	2
aa1b1481 EM	3	/**
	4	* Interface API_Wrapper
	5	*/
6a488035 TO	6	interface API_Wrapper {
	7
	8	/**
9d32e6f7 EM	9	* Interface for interpreting api input.
9d32e6f7 EM	10	*
72b3a70c	11	* @param array $apiRequest
77b97be7	12	*
72b3a70c CW	13	* @return array
72b3a70c CW	14	* modified $apiRequest
6a488035	15	*/
408b79bf	16	public function fromApiInput($apiRequest);
6a488035 TO	17
6a488035 TO	18	/**
9d32e6f7 EM	19	* Interface for interpreting api output.
9d32e6f7 EM	20	*
72b3a70c CW	21	* @param array $apiRequest
72b3a70c CW	22	* @param array $result
77b97be7	23	*
72b3a70c CW	24	* @return array
72b3a70c CW	25	* modified $result
6a488035	26	*/
408b79bf	27	public function toApiOutput($apiRequest, $result);
96025800	28
6a488035	29	}