Mass cleanup of docblocks/code/comments

[civicrm-core.git] / CRM / Import / DataSource / SQL.php

diff --git a/CRM/Import/DataSource/SQL.php b/CRM/Import/DataSource/SQL.php
index 5a9b3b9d2e175356d96de669dba27c659301e81c..1f179171891982960ddf0b5e677ef99e92bfa40f 100644 (file)
--- a/CRM/Import/DataSource/SQL.php
+++ b/CRM/Import/DataSource/SQL.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,24 +28,54 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
 class CRM_Import_DataSource_SQL extends CRM_Import_DataSource {
 
+  /**
+   * Provides information about the data source
+   *
+   * @return array collection of info about this data source
+   *
+   * @access public
+   *
+   */
   public function getInfo() {
     return array('title' => ts('SQL Query'));
   }
 
+  /**
+   * set variables up before form is built
+   *
+   * @access public
+   */
   public function preProcess(&$form) {}
 
+  /**
+   * This is function is called by the form object to get the DataSource's
+   * form snippet. It should add all fields necesarry to get the data
+   * uploaded to the temporary table in the DB.
+   *
+   * @param CRM_Core_Form $form
+   *
+   * @return void (operates directly on form argument)
+   * @access public
+   */
   public function buildQuickForm(&$form) {
     $form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_SQL');
     $form->add('textarea', 'sqlQuery', ts('Specify SQL Query'), 'rows=10 cols=45', TRUE);
     $form->addFormRule(array('CRM_Import_DataSource_SQL', 'formRule'), $form);
   }
 
+  /**
+   * @param $fields
+   * @param $files
+   * @param CRM_Core_Form $form
+   *
+   * @return array|bool
+   */
   static function formRule($fields, $files, $form) {
     $errors = array();
 
@@ -60,6 +90,11 @@ class CRM_Import_DataSource_SQL extends CRM_Import_DataSource {
     return $errors ? $errors : TRUE;
   }
 
+  /**
+   * Process the form submission
+   *
+   * @access public
+   */
   public function postProcess(&$params, &$db, &$form) {
     $importJob = new CRM_Contact_Import_ImportJob(
       CRM_Utils_Array::value( 'import_table_name', $params ),