INFRA-132 - Newline after "{"

[civicrm-core.git] / bin / cli.class.php

diff --git a/bin/cli.class.php b/bin/cli.class.php
index a821dc21e6e24d5dae40f8584f1c2cb59775994a..d64802efb5f56dbc512cc819264046988ee7b95f 100644 (file)
--- a/bin/cli.class.php
+++ b/bin/cli.class.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright Tech To The People http:tttp.eu (c) 2008                 |
  +--------------------------------------------------------------------+
@@ -59,6 +59,9 @@ class civicrm_cli {
 
   var $_errors = array();
 
+  /**
+   * @return bool
+   */
   public function initialize() {
     if (!$this->_accessing_from_cli()) {
       return FALSE;
@@ -84,6 +87,9 @@ class civicrm_cli {
     }
   }
 
+  /**
+   * @return bool
+   */
   public function callApi() {
     require_once 'api/api.php';
 
@@ -110,6 +116,9 @@ class civicrm_cli {
     return TRUE;
   }
 
+  /**
+   * @return bool
+   */
   private function _parseOptions() {
     $args = $_SERVER['argv'];
     // remove the first argument, which is the name
@@ -166,7 +175,7 @@ class civicrm_cli {
         $this->_joblog = TRUE;
       }
       else {
-        while(list($short, $long) = each ($this->_additional_arguments)) {
+        while (list($short, $long) = each($this->_additional_arguments)) {
           if ($arg == '-' . $short || $arg == '--' . $long) {
             $property = '_' . $long;
             $this->$property = $value;
@@ -181,6 +190,9 @@ class civicrm_cli {
     return TRUE;
   }
 
+  /**
+   * @return bool
+   */
   private function _bootstrap() {
     // so the configuration works with php-cli
     $_SERVER['PHP_SELF'] = "/index.php";
@@ -199,7 +211,7 @@ class civicrm_cli {
 
     $civicrm_root = dirname(__DIR__);
     chdir($civicrm_root);
-    require_once ('civicrm.config.php');
+    require_once 'civicrm.config.php';
     // autoload
     if ( !class_exists('CRM_Core_ClassLoader') ) {
       require_once $civicrm_root . '/CRM/Core/ClassLoader.php';
@@ -207,12 +219,12 @@ class civicrm_cli {
     CRM_Core_ClassLoader::singleton()->register();
 
     $this->_config = CRM_Core_Config::singleton();
-    
+
     // HTTP_HOST will be 'localhost' unless overwritten with the -s argument.
     // Now we have a Config object, we can set it from the Base URL.
     if ($_SERVER['HTTP_HOST'] == 'localhost') {
-        $_SERVER['HTTP_HOST'] = preg_replace(
-                '!^https?://([^/]+)/$!i', 
+      $_SERVER['HTTP_HOST'] = preg_replace(
+                '!^https?://([^/]+)/$!i',
                 '$1',
                 $this->_config->userFrameworkBaseURL);
     }
@@ -233,7 +245,7 @@ class civicrm_cli {
     }
 
     if (!empty($this->_user)) {
-      if(!CRM_Utils_System::authenticateScript(TRUE, $this->_user, $this->_password, TRUE, FALSE, FALSE)) {
+      if (!CRM_Utils_System::authenticateScript(TRUE, $this->_user, $this->_password, TRUE, FALSE, FALSE)) {
         $this->_log(ts("Failed to login as %1. Wrong username or password.", array('1' => $this->_user)));
         return FALSE;
       }
@@ -246,6 +258,9 @@ class civicrm_cli {
     return TRUE;
   }
 
+  /**
+   * @return bool
+   */
   private function _validateOptions() {
     $required = $this->_required_arguments;
     while (list(, $var) = each($required)) {
@@ -260,12 +275,20 @@ class civicrm_cli {
     return TRUE;
   }
 
+  /**
+   * @param $value
+   *
+   * @return string
+   */
   private function _sanitize($value) {
     // restrict user input - we should not be needing anything
     // other than normal alpha numeric plus - and _.
     return trim(preg_replace('#^[^a-zA-Z0-9\-_=/]$#', '', $value));
   }
 
+  /**
+   * @return string
+   */
   private function _getUsage() {
     $out = "Usage: cli.php -e entity -a action [-u user] [-s site] [--output] [PARAMS]\n";
     $out .= "  entity is the name of the entity, e.g. Contact, Event, etc.\n";
@@ -277,6 +300,9 @@ class civicrm_cli {
     return ts($out);
   }
 
+  /**
+   * @param $error
+   */
   private function _log($error) {
     // fixme, this should call some CRM_Core_Error:: function
     // that properly logs
@@ -292,6 +318,9 @@ class civicrm_cli {
 class civicrm_cli_csv_exporter extends civicrm_cli {
   var $separator = ',';
 
+  /**
+   *
+   */
   function __construct() {
     $this->_required_arguments = array('entity');
     parent::initialize();
@@ -303,18 +332,18 @@ class civicrm_cli_csv_exporter extends civicrm_cli {
 
     $this->row = 1;
     $result = civicrm_api($this->_entity, 'Get', $this->_params);
-    $first = true;
+    $first = TRUE;
     foreach ($result['values'] as $row) {
-      if($first) {
+      if ($first) {
         $columns = array_keys($row);
         fputcsv($out, $columns, $this->separator, '"');
-        $first = false;
+        $first = FALSE;
       }
       //handle values returned as arrays (i.e. custom fields that allow multiple selections) by inserting a control character
       foreach ($row as &$field) {
-        if(is_array($field)) {
+        if (is_array($field)) {
           //convert to string
-          $field = implode($field,CRM_Core_DAO::VALUE_SEPARATOR) . CRM_Core_DAO::VALUE_SEPARATOR;
+          $field = implode($field, CRM_Core_DAO::VALUE_SEPARATOR) . CRM_Core_DAO::VALUE_SEPARATOR;
         }
       }
       fputcsv($out, $row, $this->separator, '"');
@@ -335,8 +364,11 @@ class civicrm_cli_csv_file extends civicrm_cli {
   var $header;
   var $separator = ',';
 
+  /**
+   *
+   */
   function __construct() {
-    $this->_required_arguments = array('entity','file');
+    $this->_required_arguments = array('entity', 'file');
     $this->_additional_arguments = array('f' => 'file');
     parent::initialize();
   }
@@ -365,7 +397,9 @@ class civicrm_cli_csv_file extends civicrm_cli {
     $this->header = $header;
     while (($data = fgetcsv($handle, 0, $this->separator)) !== FALSE) {
       // skip blank lines
-      if(count($data) == 1 && is_null($data[0])) continue;
+      if (count($data) == 1 && is_null($data[0])) {
+        continue;
+      }
       $this->row++;
       $params = $this->convertLine($data);
       $this->processLine($params);
@@ -375,12 +409,17 @@ class civicrm_cli_csv_file extends civicrm_cli {
   }
 
   /* return a params as expected */
+  /**
+   * @param $data
+   *
+   * @return array
+   */
   function convertLine($data) {
     $params = array();
     foreach ($this->header as $i => $field) {
       //split any multiselect data, denoted with CRM_Core_DAO::VALUE_SEPARATOR
       if (strpos($data[$i], CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
-        $data[$i] = explode(CRM_Core_DAO::VALUE_SEPARATOR,$data[$i]);
+        $data[$i] = explode(CRM_Core_DAO::VALUE_SEPARATOR, $data[$i]);
         $data[$i] = array_combine($data[$i], $data[$i]);
       }
       $params[$field] = $data[$i];
@@ -397,6 +436,9 @@ class civicrm_cli_csv_file extends civicrm_cli {
  **/
 
 class civicrm_cli_csv_importer extends civicrm_cli_csv_file {
+  /**
+   * @param array $params
+   */
   function processline($params) {
     $result = civicrm_api($this->_entity, 'Create', $params);
     if ($result['is_error']) {
@@ -415,11 +457,15 @@ class civicrm_cli_csv_importer extends civicrm_cli_csv_file {
  **/
 
 class civicrm_cli_csv_deleter extends civicrm_cli_csv_file {
+  /**
+   * @param array $params
+   */
   function processline($params) {
     $result = civicrm_api($this->_entity, 'Delete', $params);
     if ($result['is_error']) {
       echo "\nERROR line " . $this->row . ": " . $result['error_message'] . "\n";
-    } else {
+    }
+    else {
       echo "\nline " . $this->row . ": deleted\n";
     }
   }