CRM-15905 fix - API: problem sorting contacts on ID

[civicrm-core.git] / api / v3 / Relationship.php

diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php
index 29ddb20e430c8f9197a2ef58a7baf40a999a65cc..9e0456e1764bf37c4f502bfb54d2b5644a559acb 100644 (file)
--- a/api/v3/Relationship.php
+++ b/api/v3/Relationship.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * File for the CiviCRM APIv3 relationship functions
@@ -34,23 +33,18 @@
  *
  * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: Relationship.php 30486 2010-11-02 16:12:09Z shot $
- *
  */
 
 /**
- * Add or update a relationship
+ * Add or update a relationship.
  *
  * @param array $params
  *   Input parameters.
  *
  * @throws API_Exception
- * @example RelationshipCreate.php Std Create example
  *
  * @return array
-   *   API Result Array
- * {@getfields relationship_create}
- * @static void
- * @access public
+ *   API Result Array
  */
 function civicrm_api3_relationship_create($params) {
   _civicrm_api3_handle_relationship_type($params);
@@ -58,7 +52,7 @@ function civicrm_api3_relationship_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
  *
  * @param array $params
  *   Array or parameters determined by getfields.
@@ -71,17 +65,12 @@ function _civicrm_api3_relationship_create_spec(&$params) {
 }
 
 /**
- * Delete a relationship
+ * Delete a relationship.
  *
  * @param array $params
  *
  * @return array
-   *   API Result Array
- * {@getfields relationship_delete}
- * @example RelationshipDelete.php Delete Example
- *
- * @static void
- * @access public
+ *   API Result Array
  */
 function civicrm_api3_relationship_delete($params) {
 
@@ -101,19 +90,17 @@ function civicrm_api3_relationship_delete($params) {
 }
 
 /**
- * get the relationship
+ * Get one or more relationship/s.
  *
  * @param array $params
  *   Input parameters.
+ *
  * @todo  Result is inconsistent depending on whether contact_id is passed in :
  * -  if you pass in contact_id - it just returns all relationships for 'contact_id'
  * -  if you don't pass in contact_id then it does a filter on the relationship table (DAO based search)
  *
- * @return Array
-   *   API Result Array
- * {@getfields relationship_get}
- * @example RelationshipGet.php
- * @access  public
+ * @return array
+ *   API Result Array
  */
 function civicrm_api3_relationship_get($params) {
   $options = _civicrm_api3_get_options_from_params($params);
@@ -147,7 +134,7 @@ function civicrm_api3_relationship_get($params) {
 }
 
 /**
- * legacy handling for relationship_type parameter
+ * Legacy handling for relationship_type parameter.
  *
  * @param array $params
  *   Associative array of property name/value.