Merge pull request #16263 from eileenmcnaughton/ids_3

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

diff --git a/bin/cli.class.php b/bin/cli.class.php
index 8f6705f2d0087c1d0eb0c8a6c82ba30db2187da6..dff79069f40ae90664f266ecd761f7a2231985cf 100644 (file)
--- a/bin/cli.class.php
+++ b/bin/cli.class.php
@@ -39,26 +39,35 @@
  */
 class civicrm_cli {
   // required values that must be passed
-  // via the command line
-  var $_required_arguments = array('action', 'entity');
-  var $_additional_arguments = array();
-  var $_entity = NULL;
-  var $_action = NULL;
-  var $_output = FALSE;
-  var $_joblog = FALSE;
-  var $_semicolon = FALSE;
-  var $_config;
-
-  // optional arguments
-  var $_site = 'localhost';
-  var $_user = NULL;
-  var $_password = NULL;
+  /**
+   * via the command line
+   * @var array
+   */
+  public $_required_arguments = array('action', 'entity');
+  public $_additional_arguments = array();
+  public $_entity = NULL;
+  public $_action = NULL;
+  public $_output = FALSE;
+  public $_joblog = FALSE;
+  public $_semicolon = FALSE;
+  public $_config;
+
+  /**
+   * optional arguments
+   * @var string
+   */
+  public $_site = 'localhost';
+  public $_user = NULL;
+  public $_password = NULL;
 
   // all other arguments populate the parameters
-  // array that is passed to civicrm_api
-  var $_params = array('version' => 3);
+  /**
+   * array that is passed to civicrm_api
+   * @var array
+   */
+  public $_params = array('version' => 3);
 
-  var $_errors = array();
+  public $_errors = array();
 
   /**
    * @return bool
@@ -137,7 +146,7 @@ class civicrm_cli {
     // of this script
     array_shift($args);
 
-    while (list($k, $arg) = each($args)) {
+    foreach ($args as $k => $arg) {
       // sanitize all user input
       $arg = $this->_sanitize($arg);
 
@@ -285,8 +294,7 @@ class civicrm_cli {
    * @return bool
    */
   private function _validateOptions() {
-    $required = $this->_required_arguments;
-    while (list(, $var) = each($required)) {
+    foreach ($this->_required_arguments as $var) {
       $index = '_' . $var;
       if (empty($this->$index)) {
         $missing_arg = '--' . $var;
@@ -340,7 +348,7 @@ class civicrm_cli {
  * the database in a csv file format.
  */
 class civicrm_cli_csv_exporter extends civicrm_cli {
-  var $separator = ',';
+  public $separator = ',';
 
   /**
    */
@@ -391,8 +399,8 @@ class civicrm_cli_csv_exporter extends civicrm_cli {
  * passed to the script.
  */
 class civicrm_cli_csv_file extends civicrm_cli {
-  var $header;
-  var $separator = ',';
+  public $header;
+  public $separator = ',';
 
   /**
    */
@@ -441,6 +449,7 @@ class civicrm_cli_csv_file extends civicrm_cli {
   }
 
   /* return a params as expected */
+
   /**
    * @param $data
    *
@@ -468,6 +477,7 @@ class civicrm_cli_csv_file extends civicrm_cli {
  *
  */
 class civicrm_cli_csv_importer extends civicrm_cli_csv_file {
+
   /**
    * @param array $params
    */
@@ -489,6 +499,7 @@ class civicrm_cli_csv_importer extends civicrm_cli_csv_file {
  *
  */
 class civicrm_cli_csv_deleter extends civicrm_cli_csv_file {
+
   /**
    * @param array $params
    */