/drupal7/sites/all/modules/flag/flag.api.php - Annoter - Club Drupal - Forge Centrale Marseille

root / drupal7 / sites / all / modules / flag / flag.api.php @ ba09eb79

-ad3d82
+<?php
 /**
  * @file
  * Hooks provided by the Flag module.
  */
 /**
  * @addtogroup hooks
  * @{
  */
 /**
  * Define one or more flag types.
+ *
  * This hook may be placed in a $module.flag.inc file.
+ *
-            fd5a8e62
+ * @return array
-ad3d82
+ *  An array whose keys are flag type names and whose values are properties of
  *  the flag type.
  *  When a flag type is for an entity, the flag type name must match the entity
  *  type.
  *  Properties for flag types are as follows:
  *  - 'title': The main label of the flag type.
  *  - 'description': A longer description shown in the UI when creating a new
  *    flag.
  *  - 'handler': The name of the class implementing this flag type.
  *  - 'module': (optional) The name of the module that should be registered as a
  *    dependency for this flag type.
+ *
  * @see flag_fetch_definition()
  */
 function hook_flag_type_info() {
   return array(
     'node' => array(
       'title' => t('Nodes'),
       'description' => t("Nodes are a Drupal site's primary content."),
       'handler' => 'flag_node',
       'module' => 'node',
     ),
   );
+}
 /**
  * Alter flag type definitions provided by other modules.
+ *
  * This hook may be placed in a $module.flag.inc file.
+ *
-            fd5a8e62
+ * @param array $definitions
-ad3d82
+ *  An array of flag definitions returned by hook_flag_type_info().
  */
 function hook_flag_type_info_alter(&$definitions) {
+}
 /**
  * Define default flags.
  */
 function hook_flag_default_flags() {
   $flags = array();
-e2e7c3
+  $flags['bookmarks'] = array(
-ad3d82
+    'entity_type' => 'node',
     'title' => 'Bookmarks',
     'global' => FALSE,
-e2e7c3
+    'types' => array(
-ad3d82
+=> 'article',
 => 'blog',
     ),
     'flag_short' => 'Bookmark this',
     'flag_long' => 'Add this post to your bookmarks',
     'flag_message' => 'This post has been added to your bookmarks',
     'unflag_short' => 'Unbookmark this',
     'unflag_long' => 'Remove this post from your bookmarks',
     'unflag_message' => 'This post has been removed from your bookmarks',
     'unflag_denied_text' => '',
     'link_type' => 'toggle',
     'weight' => 0,
-e2e7c3
+    'show_in_links' => array(
-ad3d82
+      'full' => TRUE,
       'token' => FALSE,
     ),
     'show_as_field' => FALSE,
     'show_on_form' => FALSE,
     'access_author' => '',
     'show_contextual_link' => TRUE,
     'show_on_profile' => FALSE,
     'access_uid' => '',
     'api_version' => 3,
   );
   return $flags;
+}
-e2e7c3
+/**
  * Alter the definition of default flags.
+ *
  * @param array &$flags
  *   An array keyed by flag machine name containing flag definitions.
  */
 function hook_flag_default_flags_alter(&$flags) {
   if (!empty($flags['bookmark'])) {
     $flags['bookmark']['title'] = 'Bananana Bookmark';
+  }
+}
-ad3d82
+/**
  * Allow modules to alter a flag when it is initially loaded.
+ *
-e2e7c3
+ * @see flag_get_flags()
-ad3d82
+ */
 function hook_flag_alter(&$flag) {
+}
 /**
  * Alter a flag's default options.
+ *
  * Modules that wish to extend flags and provide additional options must declare
  * them here so that their additions to the flag admin form are saved into the
  * flag object.
+ *
-            fd5a8e62
+ * @param array $options
-ad3d82
+ *  The array of default options for the flag type, with the options for the
  *  flag's link type merged in.
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *  The flag object.
+ *
  * @see flag_flag::options()
  */
 function hook_flag_options_alter(&$options, $flag) {
+}
 /**
  * Act on an object being flagged.
+ *
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *  The flag object.
-            fd5a8e62
+ * @param int $entity_id
-ad3d82
+ *  The id of the entity the flag is on.
  * @param $account
  *  The user account performing the action.
  * @param $flagging_id
  *  The flagging entity.
  */
 function hook_flag_flag($flag, $entity_id, $account, $flagging) {
+}
 /**
  * Act on an object being unflagged.
+ *
  * This is invoked after the flag count has been decreased, but before the
  * flagging entity has been deleted.
+ *
  * @param $flag
  *  The flag object.
-            fd5a8e62
+ * @param int $entity_id
-ad3d82
+ *  The id of the entity the flag is on.
  * @param $account
  *  The user account performing the action.
  * @param $flagging
  *  The flagging entity.
  */
 function hook_flag_unflag($flag, $entity_id, $account, $flagging) {
+}
 /**
  * Perform custom validation on a flag before flagging/unflagging.
+ *
-            fd5a8e62
+ * @param string $action
-ad3d82
+ *  The action about to be carried out. Either 'flag' or 'unflag'.
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *  The flag object.
-            fd5a8e62
+ * @param int $entity_id
-ad3d82
+ *  The id of the entity the user is trying to flag or unflag.
  * @param $account
  *  The user account performing the action.
  * @param $flagging
  *  The flagging entity.
+ *
-            fd5a8e62
+ * @return array|NULL
-ad3d82
+ *   Optional array: textual error with the error-name as the key.
  *   If the error name is 'access-denied' and javascript is disabled,
  *   drupal_access_denied will be called and a 403 will be returned.
  *   If validation is successful, do not return a value.
  */
 function hook_flag_validate($action, $flag, $entity_id, $account, $skip_permission_check, $flagging) {
   // We're only operating on the "test" flag, and users may always unflag.
   if ($flag->name == 'test' && $action == 'flag') {
     // Get all flags set by the current user.
     $flags = flag_get_user_flags('node', NULL, $account->uid, $sid = NULL, $reset = FALSE);
     // Check if this user has any flags of this type set.
     if (isset($flags['test'])) {
       $count = count($flags[$flag->name]);
       if ($count >= 2) {
         // Users may flag only 2 nodes with this flag.
-e2e7c3
+        return (array('access-denied' => t('You may only flag 2 nodes with the test flag.')));
-ad3d82
+            Assos Assos
+    }
+  }
+}
 /**
  * Allow modules to allow or deny access to flagging for a single entity.
+ *
  * Called when displaying a single entity view or edit page.  For flag access
  * checks from within Views, implement hook_flag_access_multiple().
+ *
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *  The flag object.
  * @param $entity_id
  *  The id of the entity in question.
-            fd5a8e62
+ * @param string $action
-ad3d82
+ *  The action to test. Either 'flag' or 'unflag'.
  * @param $account
  *  The user on whose behalf to test the flagging action.
+ *
  * @return
  *   One of the following values:
  *     - TRUE: User has access to the flag.
  *     - FALSE: User does not have access to the flag.
  *     - NULL: This module does not perform checks on this flag/action.
+ *
  *   NOTE: Any module that returns FALSE will prevent the user from
  *   being able to use the flag.
+ *
  * @see hook_flag_access_multiple()
  * @see flag_flag:access()
  */
 function hook_flag_access($flag, $entity_id, $action, $account) {
+}
 /**
  * Allow modules to allow or deny access to flagging for multiple entities.
+ *
  * Called when preparing a View or list of multiple flaggable entities.
  * For flag access checks for individual entities, see hook_flag_access().
+ *
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *  The flag object.
-            fd5a8e62
+ * @param array $entity_ids
-ad3d82
+ *  An array of object ids to check access.
  * @param $account
  *  The user on whose behalf to test the flagging action.
+ *
-            fd5a8e62
+ * @return array
-ad3d82
+ *   An array whose keys are the object IDs and values are booleans indicating
-            fd5a8e62
+ *   access: TRUE to grant access, FALSE to deny it, and NULL to leave the core
  *   access unchanged. If the implementation does not wish to override any
  *   access, an empty array may be returned.
-ad3d82
+            Assos Assos
  * @see hook_flag_access()
  * @see flag_flag:access_multiple()
  */
 function hook_flag_access_multiple($flag, $entity_ids, $account) {
+}
 /**
  * Define one or more flag link types.
+ *
  * Link types defined here must be returned by this module's hook_flag_link().
+ *
  * This hook may be placed in a $module.flag.inc file.
+ *
  * @return
  *  An array of one or more types, keyed by the machine name of the type, and
  *  where each value is a link type definition as an array with the following
  *  properties:
  *  - 'title': The human-readable name of the type.
  *  - 'description': The description of the link type.
  *  - 'options': An array of extra options for the link type.
  *  - 'uses standard js': Boolean, indicates whether the link requires Flag
  *    module's own JS file for links.
  *  - 'uses standard css': Boolean, indicates whether the link requires Flag
  *    module's own CSS file for links.
  *  - 'provides form': (optional) Boolean indicating that this link type shows
  *    the user a flagging entity form. This property is used in the UI, eg to
  *    warn the admin user of link types that are not compatible with other
  *    flag options. Defaults to FALSE.
+ *
  * @see flag_get_link_types()
  * @see hook_flag_link_type_info_alter()
  */
 function hook_flag_link_type_info() {
+}
 /**
  * Alter other modules' definitions of flag link types.
+ *
  * This hook may be placed in a $module.flag.inc file.
+ *
-            fd5a8e62
+ * @param array $link_types
-ad3d82
+ *  An array of the link types defined by all modules.
+ *
  * @see flag_get_link_types()
  * @see hook_flag_link_type_info()
  */
 function hook_flag_link_type_info_alter(&$link_types) {
+}
 /**
  * Return the link for the link types this module defines.
+ *
  * The type of link to be produced is given by $flag->link_type.
+ *
  * When Flag uses a link type provided by this module, it will call this
  * implementation of hook_flag_link(). This should return a single link's
  * attributes, using the same structure as hook_link(). Note that "title" is
  * provided by the Flag configuration if not specified here.
+ *
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *   The full flag object for the flag link being generated.
-            fd5a8e62
+ * @param string $action
-ad3d82
+ *   The action this link should perform. Either 'flag' or 'unflag'.
-            fd5a8e62
+ * @param int $entity_id
-ad3d82
+ *   The ID of the node, comment, user, or other object being flagged. The type
  *   of the object can be deduced from the flag type.
+ *
  * @return
  *   An array defining properties of the link.
+ *
  * @see hook_flag_link_type_info()
  * @see template_preprocess_flag()
  */
-            fd5a8e62
+function hook_flag_link($flag, $action, $entity_id) {
-ad3d82
+            Assos Assos
+}
 /**
  * Act on flag deletion.
+ *
  * This is invoked after all the flag database tables have had their relevant
  * entries deleted.
+ *
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *  The flag object that has been deleted.
  */
 function hook_flag_delete($flag) {
+}
 /**
  * Act when a flag is reset.
+ *
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *  The flag object.
-            fd5a8e62
+ * @param int $entity_id
-ad3d82
+ *  The entity ID on which all flaggings are to be removed. May be NULL, in
  *  which case all of this flag's entities are to be unflagged.
  * @param $rows
  *  Database rows from the {flagging} table.
+ *
  * @see flag_reset_flag()
  */
 function hook_flag_reset($flag, $entity_id, $rows) {
+}
 /**
  * Alter the javascript structure that describes the flag operation.
+ *
-            fd5a8e62
+ * @param array $info
-e218c
+ *   The info array before it is returned from flag_build_javascript_info().
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *   The full flag object.
+ *
  * @see flag_build_javascript_info()
  */
-e218c
+function hook_flag_javascript_info_alter(&$info, $flag) {
   if ($flag->name === 'test') {
     $info['newLink'] = $flag->theme($flag->is_flagged($info['contentId']) ? 'unflag' : 'flag', $info['contentId'], array(
       'after_flagging' => TRUE,
       'errors' => $flag->get_errors(),
       // Additional options to pass to theme's preprocess function/template.
       'icon' => TRUE,
       'hide_text' => TRUE,
     ));
+  }
-ad3d82
+            Assos Assos
 /**
  * Alter a flag object that is being prepared for exporting.
+ *
-            fd5a8e62
+ * @param flag_flag $flag
-ad3d82
+ *  The flag object.
+ *
  * @see flag_export_flags()
  */
 function hook_flag_export_alter($flag) {
+}

Projet

Général

Profil

Club Drupal

root / drupal7 / sites / all / modules / flag / flag.api.php @ ba09eb79