X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=bin%2Fcli.class.php;h=c9215ec8619acbab2a66e44fecfc3482abc4ba0f;hb=3838662faff56daff7b4fbbd25c60a4b7242a484;hp=73d23978172e29786f14ae88e8f6c78bcf48343a;hpb=19caf82192aef46d8d6d0c01d014f508b0df0aa4;p=civicrm-core.git diff --git a/bin/cli.class.php b/bin/cli.class.php index 73d2397817..c9215ec861 100644 --- a/bin/cli.class.php +++ b/bin/cli.class.php @@ -1,7 +1,7 @@ _accessing_from_cli()) { return FALSE; @@ -83,6 +87,9 @@ class civicrm_cli { } } + /** + * @return bool + */ public function callApi() { require_once 'api/api.php'; @@ -109,6 +116,9 @@ class civicrm_cli { return TRUE; } + /** + * @return bool + */ private function _parseOptions() { $args = $_SERVER['argv']; // remove the first argument, which is the name @@ -180,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"; @@ -200,16 +213,18 @@ class civicrm_cli { chdir($civicrm_root); require_once ('civicrm.config.php'); // autoload - require_once $civicrm_root . '/CRM/Core/ClassLoader.php'; + if ( !class_exists('CRM_Core_ClassLoader') ) { + require_once $civicrm_root . '/CRM/Core/ClassLoader.php'; + } 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', + '!^https?://([^/]+)/$!i', '$1', $this->_config->userFrameworkBaseURL); } @@ -243,6 +258,9 @@ class civicrm_cli { return TRUE; } + /** + * @return bool + */ private function _validateOptions() { $required = $this->_required_arguments; while (list(, $var) = each($required)) { @@ -257,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"; @@ -274,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 @@ -289,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(); @@ -332,6 +364,9 @@ class civicrm_cli_csv_file extends civicrm_cli { var $header; var $separator = ','; + /** + * + */ function __construct() { $this->_required_arguments = array('entity','file'); $this->_additional_arguments = array('f' => 'file'); @@ -372,10 +407,15 @@ 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 + //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] = array_combine($data[$i], $data[$i]); @@ -394,6 +434,9 @@ class civicrm_cli_csv_file extends civicrm_cli { **/ class civicrm_cli_csv_importer extends civicrm_cli_csv_file { + /** + * @param $params + */ function processline($params) { $result = civicrm_api($this->_entity, 'Create', $params); if ($result['is_error']) { @@ -412,6 +455,9 @@ class civicrm_cli_csv_importer extends civicrm_cli_csv_file { **/ class civicrm_cli_csv_deleter extends civicrm_cli_csv_file { + /** + * @param $params + */ function processline($params) { $result = civicrm_api($this->_entity, 'Delete', $params); if ($result['is_error']) {