if (!is_array($names)) {
// We were called with the old contract wherein $names is actually an int.
// Symfony dispatcher requires some kind of name.
- Civi::log()->warning("hook_$fnSuffix should be updated to pass an array of parameter names to CRM_Utils_Hook::invoke().", ['civi.tag' => 'deprecated']);
+ CRM_Core_Error::deprecatedWarning("hook_$fnSuffix should be updated to pass an array of parameter names to CRM_Utils_Hook::invoke().");
$compatNames = ['arg1', 'arg2', 'arg3', 'arg4', 'arg5', 'arg6'];
$names = array_slice($compatNames, 0, (int) $names);
}
* @return null
* the return value is ignored
*/
- public static function pre($op, $objectName, $id, &$params) {
+ public static function pre($op, $objectName, $id, &$params = []) {
$event = new \Civi\Core\Event\PreEvent($op, $objectName, $id, $params);
\Civi::dispatcher()->dispatch('hook_civicrm_pre', $event);
return $event->getReturnValues();
);
}
+ /**
+ * When adding a new "Mail Account" (`MailSettings`), present a menu of setup
+ * options.
+ *
+ * @param array $setupActions
+ * Each item has a symbolic-key, and it has the properties:
+ * - title: string
+ * - callback: string|array, the function which starts the setup process.
+ * The function is expected to return a 'url' for the config screen.
+ * @return mixed
+ */
+ public static function mailSetupActions(&$setupActions) {
+ return self::singleton()->invoke(['setupActions'], $setupActions, self::$_nullObject, self::$_nullObject,
+ self::$_nullObject, self::$_nullObject, self::$_nullObject,
+ 'civicrm_mailSetupActions'
+ );
+ }
+
/**
* This hook is called when composing a mailing. You can include / exclude other groups as needed.
*
);
}
+ /**
+ * This hook is called when loading a mail-store (e.g. IMAP, POP3, or Maildir).
+ *
+ * @param array $params
+ * Most fields correspond to data in the MailSettings entity:
+ * - id: int
+ * - server: string
+ * - username: string
+ * - password: string
+ * - is_ssl: bool
+ * - source: string
+ * - local_part: string
+ *
+ * With a few supplements
+ * - protocol: string, symbolic protocol name (e.g. "IMAP")
+ * - factory: callable, the function which instantiates the driver class
+ * - auth: string, (for some drivers) specify the authentication method (eg "Password" or "XOAuth2")
+ *
+ * @return mixed
+ */
+ public static function alterMailStore(&$params) {
+ return self::singleton()->invoke(['params'], $params, $context,
+ self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
+ 'civicrm_alterMailStore'
+ );
+ }
+
/**
* This hook is called when membership status is being calculated.
*
}
/**
- * This hook is called when loading CMS permissions; use this hook to modify
+ * This hook is called when exporting Civi's permission to the CMS. Use this hook to modify
* the array of system permissions for CiviCRM.
*
* @param array $permissions
);
}
+ /**
+ * This hook is used to enumerate the list of available permissions. It may
+ * include concrete permissions defined by Civi, concrete permissions defined
+ * by the CMS, and/or synthetic permissions.
+ *
+ * @param array $permissions
+ * Array of permissions, keyed by symbolic name. Each is an array with fields:
+ * - group: string (ex: "civicrm", "cms")
+ * - title: string (ex: "CiviEvent: Register for events")
+ * - description: string (ex: "Register for events online")
+ * - is_synthetic: bool (TRUE for synthetic permissions with a bespoke evaluation. FALSE for concrete permissions that registered+granted in the UF user-management layer.
+ * Default TRUE iff name begins with '@')
+ * - is_active: bool (TRUE if this permission is defined by. Default: TRUE)
+ *
+ * @return null
+ * The return value is ignored
+ * @see Civi\Api4\Permission::get()
+ */
+ public static function permissionList(&$permissions) {
+ return self::singleton()->invoke(['permissions'], $permissions,
+ self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject, self::$_nullObject,
+ 'civicrm_permissionList'
+ );
+ }
+
/**
* This hook is called when checking permissions; use this hook to dynamically
* escalate user permissions in certain use cases (cf. CRM-19256).
}
/**
- * This hook is called while viewing contact dashboard.
+ * This hook is called while initializing the default dashlets for a contact dashboard.
*
* @param array $availableDashlets
* List of dashlets; each is formatted per api/v3/Dashboard
\Civi::dispatcher()->dispatch('hook_civicrm_caseChange', $event);
}
- /**
- * Generate a default CRUD URL for an entity.
- *
- * @param array $spec
- * With keys:.
- * - action: int, eg CRM_Core_Action::VIEW or CRM_Core_Action::UPDATE
- * - entity_table: string
- * - entity_id: int
- * @param CRM_Core_DAO $bao
- * @param array $link
- * To define the link, add these keys to $link:.
- * - title: string
- * - path: string
- * - query: array
- * - url: string (used in lieu of "path"/"query")
- * Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
- * @return mixed
- */
- public static function crudLink($spec, $bao, &$link) {
- return self::singleton()->invoke(['spec', 'bao', 'link'], $spec, $bao, $link,
- self::$_nullObject, self::$_nullObject, self::$_nullObject,
- 'civicrm_crudLink'
- );
- }
-
/**
* Modify the CiviCRM container - add new services, parameters, extensions, etc.
*
projects / civicrm-core.git / blobdiff