+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2015 |
+ | Copyright CiviCRM LLC (c) 2004-2016 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CiviCRM_Hook
- * @copyright CiviCRM LLC (c) 2004-2015
+ * @copyright CiviCRM LLC (c) 2004-2016
*/
abstract class CRM_Utils_Hook {
->invoke(5, $type, $contactID, $tableName, $allGroups, $currentGroups, self::$_nullObject, 'civicrm_aclGroup');
}
+ /**
+ * @param string|CRM_Core_DAO $entity
+ * @param array $clauses
+ * @return mixed
+ */
+ public static function selectWhereClause($entity, &$clauses) {
+ $entityName = is_object($entity) ? _civicrm_api_get_entity_name_from_dao($entity) : $entity;
+ return self::singleton()->invoke(2, $entityName, $clauses,
+ self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
+ 'civicrm_selectWhereClause'
+ );
+ }
+
/**
* This hook is called when building the menu table.
*
* The contactID for whom the dashboard is being rendered.
*
* @return null
+ * @deprecated Use tabset() instead.
*/
public static function tabs(&$tabs, $contactID) {
return self::singleton()->invoke(2, $tabs, $contactID,
}
/**
- * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox,
- * adv multiselect)
+ * This hook is called when CiviCRM needs to edit/display a custom field with options
+ *
+ * @deprecated in favor of hook_civicrm_fieldOptions
*
* @param int $customFieldID
* The custom field ID.
* to be careful to not overwrite the array.
* Only add/edit/remove the specific field options you intend to affect.
* @param bool $detailedFormat
- * If true,.
- * the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
+ * If true, the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
* @param array $selectAttributes
* Contain select attribute(s) if any.
*
);
}
+ /**
+ * Hook for modifying field options
+ *
+ * @param string $entity
+ * @param string $field
+ * @param array $options
+ * @param array $params
+ *
+ * @return mixed
+ */
+ public static function fieldOptions($entity, $field, &$options, $params) {
+ return self::singleton()->invoke(5, $entity, $field, $options, $params,
+ self::$_nullObject, self::$_nullObject,
+ 'civicrm_fieldOptions'
+ );
+ }
+
/**
*
* This hook is called to display the list of actions allowed after doing a search.
/**
* This hook is called after getting the content of the mail and before tokenizing it.
*
- * @param array $templates
+ * @param array $content
* Array fields include: html, text, subject
*
* @return mixed
*/
- public static function alterMailTemplates(&$templates) {
- return self::singleton()->invoke(1, $templates,
+ public static function alterMailContent(&$content) {
+ return self::singleton()->invoke(1, $content,
self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
- 'civicrm_alterMailTemplates'
+ 'civicrm_alterMailContent'
);
}
/**
* This hooks allows to change option values.
*
+ * @deprecated in favor of hook_civicrm_fieldOptions
+ *
* @param array $options
* Associated array of option values / id
* @param string $name
);
}
+ /**
+ * This hook is called when a CiviMail mailing has completed
+ *
+ * @param int $mailingId
+ * Mailing ID
+ *
+ * @return mixed
+ */
+ public static function postMailing($mailingId) {
+ return self::singleton()->invoke(1, $mailingId,
+ self::$_nullObject, self::$_nullObject,
+ self::$_nullObject, self::$_nullObject, self::$_nullObject,
+ 'civicrm_postMailing'
+ );
+ }
+
/**
* This hook is called when Settings specifications are loaded.
*
* @return mixed
* @see Mail::factory
*/
- public static function alterMail(&$mailer, $driver, $params) {
+ public static function alterMailer(&$mailer, $driver, $params) {
return self::singleton()
->invoke(3, $mailer, $driver, $params, self::$_nullObject, self::$_nullObject, self::$_nullObject, 'civicrm_alterMailer');
}
+ /**
+ * Deprecated: Misnamed version of alterMailer(). Remove post-4.7.x.
+ * Modify or replace the Mailer object used for outgoing mail.
+ *
+ * @param object $mailer
+ * The default mailer produced by normal configuration; a PEAR "Mail" class (like those returned by Mail::factory)
+ * @param string $driver
+ * The type of the default mailer (eg "smtp", "sendmail", "mock", "CRM_Mailing_BAO_Spool")
+ * @param array $params
+ * The default mailer config options
+ *
+ * @return mixed
+ * @see Mail::factory
+ * @deprecated
+ */
+ public static function alterMail(&$mailer, $driver, $params) {
+ return CRM_Utils_Hook::alterMailer($mailer, $driver, $params);
+ }
+
/**
* This hook is called while building the core search query,
* so hook implementers can provide their own query objects which alters/extends core search.
);
}
+ /**
+ * This hook is called for bypass a few civicrm urls from IDS check
+ * @param array $skip list of civicrm url;
+ */
+ public static function idsException(&$skip) {
+ return self::singleton()->invoke(1, $skip, self::$_nullObject,
+ self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
+ 'civicrm_idsException'
+ );
+ }
+
}
projects / civicrm-core.git / blobdiff