+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
- * File for the CiviCRM APIv3 extension functions
+ * This provides an api interface for CiviCRM extension management.
*
* @package CiviCRM_APIv3
- * @subpackage API_Extension
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id$
- *
*/
/**
- * Install an extension
+ * Install an extension.
*
* @param array $params
* Input parameters.
- * - key: string, eg "com.example.myextension"
- * - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
- * using 'keys' should be more performant than making multiple API calls with 'key'
+ * - key: string, eg "com.example.myextension"
+ * - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
+ * Using 'keys' should be more performant than making multiple API calls with 'key'.
*
* @return array
* API result
}
/**
- * Enable an extension
+ * Enable an extension.
*
* @param array $params
* Input parameters.
- * - key: string, eg "com.example.myextension"
- * - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
- * using 'keys' should be more performant than making multiple API calls with 'key'
+ * - key: string, eg "com.example.myextension"
+ * - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
+ * using 'keys' should be more performant than making multiple API calls with 'key'
*
* @return array
* API result
}
/**
- * Uninstall an extension,
+ * Uninstall an extension.
*
* @param array $params
* Input parameters.
}
/**
- * Download and install an extension
+ * Download and install an extension.
*
* @param array $params
* Input parameters.
- * - key: string, eg "com.example.myextension"
- * - url: string eg "http://repo.com/myextension-1.0.zip"
+ * - key: string, eg "com.example.myextension"
+ * - url: string eg "http://repo.com/myextension-1.0.zip"
*
* @throws API_Exception
* @return array
* API result
- * @example ExtensionDownload.php
*/
function civicrm_api3_extension_download($params) {
if (!array_key_exists('key', $params)) {
}
/**
- * Download and install an extension
+ * Download and install an extension.
*
* @param array $params
* Input parameters.
- * - local: bool, whether to rescan local filesystem (default: TRUE)
- * - remote: bool, whether to rescan remote repository (default: TRUE)
+ * - local: bool, whether to rescan local filesystem (default: TRUE)
+ * - remote: bool, whether to rescan remote repository (default: TRUE)
*
* @return array
* API result
- * @example ExtensionRefresh.php
- *
*/
function civicrm_api3_extension_refresh($params) {
$defaults = array('local' => TRUE, 'remote' => TRUE);