INFRA-132 - CRM/Export - Convert single-line @param to multi-line
authorTim Otten <totten@civicrm.org>
Tue, 6 Jan 2015 19:41:08 +0000 (11:41 -0800)
committerTim Otten <totten@civicrm.org>
Tue, 6 Jan 2015 23:02:28 +0000 (15:02 -0800)
CRM/Export/BAO/Export.php
CRM/Export/Form/Map.php
CRM/Export/Form/Select.php

index 564d95de0337e57589da96efe15242dd4e2c57d1..ba37c76ca077319ff348b2195e08b92c6a5f3c33 100644 (file)
@@ -46,17 +46,28 @@ class CRM_Export_BAO_Export {
   /**
    * Get the list the export fields
    *
-   * @param int $selectAll user preference while export
-   * @param array $ids contact ids
-   * @param array $params associated array of fields
-   * @param string $order order by clause
-   * @param array $fields associated array of fields
-   * @param array $moreReturnProperties additional return fields
-   * @param int $exportMode export mode
-   * @param string $componentClause component clause
-   * @param string $componentTable component table
-   * @param bool $mergeSameAddress merge records if they have same address
-   * @param bool $mergeSameHousehold merge records if they belong to the same household
+   * @param int $selectAll
+   *   User preference while export.
+   * @param array $ids
+   *   Contact ids.
+   * @param array $params
+   *   Associated array of fields.
+   * @param string $order
+   *   Order by clause.
+   * @param array $fields
+   *   Associated array of fields.
+   * @param array $moreReturnProperties
+   *   Additional return fields.
+   * @param int $exportMode
+   *   Export mode.
+   * @param string $componentClause
+   *   Component clause.
+   * @param string $componentTable
+   *   Component table.
+   * @param bool $mergeSameAddress
+   *   Merge records if they have same address.
+   * @param bool $mergeSameHousehold
+   *   Merge records if they belong to the same household.
    *
    * @param array $exportParams
    * @param string $queryOperator
@@ -1172,8 +1183,10 @@ INSERT INTO {$componentTable} SELECT distinct gc.contact_id FROM civicrm_group_c
   /**
    * Name of the export file based on mode
    *
-   * @param string  $output type of output
-   * @param int     $mode export mode
+   * @param string $output
+   *   Type of output.
+   * @param int $mode
+   *   Export mode.
    *
    * @return string name of the file
    */
@@ -1794,10 +1807,14 @@ WHERE  id IN ( $deleteIDString )
    * Merge household record into the individual record
    * if exists
    *
-   * @param string $exportTempTable temporary temp table that stores the records
-   * @param array  $headerRows array of headers for the export file
-   * @param array  $sqlColumns array of names of the table columns of the temp table
-   * @param string $prefix name of the relationship type that is prefixed to the table columns
+   * @param string $exportTempTable
+   *   Temporary temp table that stores the records.
+   * @param array $headerRows
+   *   Array of headers for the export file.
+   * @param array $sqlColumns
+   *   Array of names of the table columns of the temp table.
+   * @param string $prefix
+   *   Name of the relationship type that is prefixed to the table columns.
    */
   public static function mergeSameHousehold($exportTempTable, &$headerRows, &$sqlColumns, $prefix) {
     $prefixColumn = $prefix . '_';
index db9160fa2ea768a2f9ff37a1fbcbf570a57b0a8a..25f9f37b6253c1c00d07b8d23a5b9da7eab0ae13 100644 (file)
@@ -106,7 +106,8 @@ class CRM_Export_Form_Map extends CRM_Core_Form {
   /**
    * Global validation rules for the form
    *
-   * @param array $fields posted values of the form
+   * @param array $fields
+   *   Posted values of the form.
    *
    * @param $values
    * @param int $mappingTypeId
index 6b7b72eda574a45962509acc49cf6eac72e817c2..98362b74f73950fc352cdb39bebb6e723d4e8bef 100644 (file)
@@ -332,7 +332,8 @@ FROM   {$this->_componentTable}
   /**
    * Validation
    *
-   * @param array $params (ref.) an assoc array of name/value pairs
+   * @param array $params
+   *   (ref.) an assoc array of name/value pairs.
    *
    * @param $files
    * @param $self