* @package CRM
* @copyright CiviCRM LLC (c) 2004-2014
* $Id$
- *
+ * @param $filesDirectory
*/
function civicrm_setup($filesDirectory) {
global $crmPath, $sqlPath, $pkgPath, $tplPath;
/**
* Just check that the database configuration is okay
+ * @param $databaseConfig
+ * @param $dbName
*/
function checkdatabase($databaseConfig, $dbName) {
if ($this->requireFunction('mysql_connect',
/**
* class constructor
+ * @param null $title
+ * @param bool|int $action
+ * @param bool $modal
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
require_once 'CRM/Auction/StateMachine/Item.php';
/**
* Test Function used for new hs-widget.
+ * @param $config
*/
function states(&$config) {
$elements = array();
/**
* Test Function used for new hs-widget.
+ * @param $config
*/
function countries(&$config) {
//get the country limit and restrict the combo select options
* (Delegated) Implementation of hook_civicrm_config
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
+ * @param null $config
*/
function _angularex_civix_civicrm_config(&$config = NULL) {
static $configured = FALSE;
}
return $result;
}
+
/**
* (Delegated) Implementation of hook_civicrm_managed
*
* Find any *.mgd.php files, merge their content, and return.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
+ * @param $entities
*/
function _angularex_civix_civicrm_managed(&$entities) {
$mgdFiles = _angularex_civix_find_files(__DIR__, '*.mgd.php');
* Note: This hook only runs in CiviCRM 4.4+.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
+ * @param $caseTypes
+ * @throws \Exception
*/
function _angularex_civix_civicrm_caseTypes(&$caseTypes) {
if (!is_dir(__DIR__ . '/xml/case')) {
* $path - path where insertion should happen (ie. Administer/System Settings)
* $item - menu you need to insert (parent/child attributes will be filled for you)
* $parentId - used internally to recurse in the menu structure
+ * @param $menu
+ * @param $path
+ * @param $item
+ * @param null $parentId
+ * @return bool
*/
function _angularex_civix_insert_navigation_menu(&$menu, $path, $item, $parentId = NULL) {
static $navId;
* (Delegated) Implementation of hook_civicrm_alterSettingsFolders
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
+ * @param null $metaDataFolders
*/
function _angularex_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
static $configured = FALSE;
if(is_dir($settingsDir) && !in_array($settingsDir, $metaDataFolders)) {
$metaDataFolders[] = $settingsDir;
}
-}
\ No newline at end of file
+}
* Implementation of hook_civicrm_config
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
+ * @param $config
*/
function angularex_civicrm_config(&$config) {
_angularex_civix_civicrm_config($config);
* is installed, disabled, uninstalled.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
+ * @param $entities
*/
function angularex_civicrm_managed(&$entities) {
return _angularex_civix_civicrm_managed($entities);
* Note: This hook only runs in CiviCRM 4.4+.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
+ * @param $caseTypes
*/
function angularex_civicrm_caseTypes(&$caseTypes) {
_angularex_civix_civicrm_caseTypes($caseTypes);
* Implementation of hook_civicrm_alterSettingsFolders
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
+ * @param null $metaDataFolders
*/
function angularex_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
_angularex_civix_civicrm_alterSettingsFolders($metaDataFolders);
/**
* Perform some business logic
+ * @param \CRM_Queue_TaskContext $ctx
+ * @param $delay
+ * @param $message
+ * @return bool
*/
static function doMyWork(CRM_Queue_TaskContext $ctx, $delay, $message) {
sleep(1);
/**
* Perform some business logic
+ * @param \CRM_Queue_TaskContext $ctx
+ * @return bool
*/
static function addMoreWork(CRM_Queue_TaskContext $ctx) {
sleep(1);
/**
* Handle the final step of the queue
+ * @param \CRM_Queue_TaskContext $ctx
*/
static function onEnd(CRM_Queue_TaskContext $ctx) {
//CRM_Utils_System::redirect('civicrm/demo-queue/done');
/**
* (Delegated) Implementation of hook_civicrm_config
+ * @param $config
*/
function _demoqueue_civix_civicrm_config(&$config) {
$template =& CRM_Core_Smarty::singleton();
/**
* Implementation of hook_civicrm_config
+ * @param $config
*/
function demoqueue_civicrm_config(&$config) {
_demoqueue_civix_civicrm_config($config);
/**
* (Delegated) Implementation of hook_civicrm_config
+ * @param null $config
*/
function _multisite_civix_civicrm_config(&$config = NULL) {
static $configured = FALSE;
/**
* (Delegated) Implementation of hook_civicrm_alterSettingsMetaData
+ * @param null $metaDataFolders
*/
function _multisite_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
static $configured = FALSE;
}
return $result;
}
+
/**
* (Delegated) Implementation of hook_civicrm_managed
*
* Find any *.mgd.php files, merge their content, and return.
+ * @param $entities
*/
function _multisite_civix_civicrm_managed(&$entities) {
$mgdFiles = _multisite_civix_find_files(__DIR__, '*.mgd.php');
/**
* Implementation of hook_civicrm_config
+ * @param $config
*/
function multisite_civicrm_config(&$config) {
_multisite_civix_civicrm_config($config);
*
* Generate a list of entities to create/deactivate/delete when this module
* is installed, disabled, uninstalled.
+ * @param $entities
*/
function multisite_civicrm_managed(&$entities) {
return _multisite_civix_civicrm_managed($entities);
/**
* Implementation of hook_civicrm_config
+ * @param null $metaDataFolders
*/
function multisite_civicrm_alterSettingsFolders(&$metaDataFolders = NULL){
_multisite_civix_civicrm_alterSettingsFolders($metaDataFolders);
* @paymentProcessor is the array of payment processor settings value.
* @searchParamsnvpStr is the array of search params.
* returns an associtive array containing the response from the server.
+ * @param $paymentProcessor
+ * @param $searchParams
+ * @return array|object
+ * @throws \Exception
*/
function invokeAPI($paymentProcessor, $searchParams) {
$merchantID = $paymentProcessor['user_name'];
/**
* This method is handles the response that will be invoked (from extern/googleNotify) every time
* a notification or request is sent by the Google Server.
- *
+ * @param $xml_response
*/
static
function main($xml_response) {
return TRUE;
}
- /**
- * Converts the comma separated name-value pairs in <merchant-private-data>
- * to an array of name-value pairs.
- */
+ /**
+ * Converts the comma separated name-value pairs in <merchant-private-data>
+ * to an array of name-value pairs.
+ * @param $str
+ * @return array
+ */
static
function stringToArray($str) {
$vars = $labels = array();
/**
* Construct the search query
+ * @param int $offset
+ * @param int $rowcount
+ * @param null $sort
+ * @param bool $includeContactIDs
+ * @param bool $onlyIDs
+ * @return string
*/
function all($offset = 0, $rowcount = 0, $sort = NULL,
$includeContactIDs = FALSE, $onlyIDs = FALSE
/**
* Split a large array of contactIDs into more manageable smaller chunks
+ * @param $contactIDs
+ * @return array
*/
function &splitContactIDs(&$contactIDs) {
// contactIDs could be a real large array, so we split it up into
/**
* Given an array of values, generate the JSON in the Solr format
+ * @param $values
+ * @return string
*/
function &generateSolrJSON($values) {
$result = "[";
/**
* Given a set of contact IDs get the values
+ * @param $contactIDs
+ * @param $values
+ * @return array
*/
function getValues(&$contactIDs, &$values) {
$values = array();
/**
* Split a large array of contactIDs into more manageable smaller chunks
+ * @param $contactIDs
+ * @return array
*/
function &splitContactIDs(&$contactIDs) {
// contactIDs could be a real large array, so we split it up into
/**
* Given an array of values, generate the XML in the Solr format
+ * @param $values
+ * @return string
*/
function &generateSolrXML($values) {
$result = "<add>\n";
/**
* Given a set of contact IDs get the values
+ * @param $contactIDs
+ * @param $values
+ * @return array
*/
function getValues(&$contactIDs, &$values) {
$values = array();
/**
* Split a large array of contactIDs into more manageable smaller chunks
+ * @param $contactIDs
+ * @return array
*/
function &splitContactIDs(&$contactIDs) {
// contactIDs could be a real large array, so we split it up into
/**
* Given a set of contact IDs get the values
+ * @param $contactIDs
+ * @param $values
+ * @param $allContactIDs
+ * @param $addditionalContactIDs
+ * @return array
*/
function getValues(&$contactIDs, &$values, &$allContactIDs, &$addditionalContactIDs) {
$values = array();
/**
* Determine if snippet of JS returns strictly false
+ * @param $js
+ * @return bool
*/
function js_returns_false($js) {
return
/**
* Determine if snippet of JS returns a function call
+ * @param $js
+ * @return int
*/
function js_returns_func($js) {
return preg_match('/^ *return +[a-zA-Z0-9\._$]+\(/', $js);
projects / civicrm-core.git / commitdiff