From b9add4b3322c86845343627045fcab6c83e6176d Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:08 -0800 Subject: [PATCH] INFRA-132 - CRM/Export - Convert single-line @param to multi-line --- CRM/Export/BAO/Export.php | 51 +++++++++++++++++++++++++------------- CRM/Export/Form/Map.php | 3 ++- CRM/Export/Form/Select.php | 3 ++- 3 files changed, 38 insertions(+), 19 deletions(-) diff --git a/CRM/Export/BAO/Export.php b/CRM/Export/BAO/Export.php index 564d95de03..ba37c76ca0 100644 --- a/CRM/Export/BAO/Export.php +++ b/CRM/Export/BAO/Export.php @@ -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 . '_'; diff --git a/CRM/Export/Form/Map.php b/CRM/Export/Form/Map.php index db9160fa2e..25f9f37b62 100644 --- a/CRM/Export/Form/Map.php +++ b/CRM/Export/Form/Map.php @@ -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 diff --git a/CRM/Export/Form/Select.php b/CRM/Export/Form/Select.php index 6b7b72eda5..98362b74f7 100644 --- a/CRM/Export/Form/Select.php +++ b/CRM/Export/Form/Select.php @@ -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 -- 2.25.1