You are here

class flag_broken in Flag 7.3

Same name and namespace in other branches
  1. 5 flag.inc \flag_broken
  2. 6.2 flag.inc \flag_broken
  3. 6 flag.inc \flag_broken
  4. 7.2 flag.inc \flag_broken

A dummy flag to be used where the real implementation can't be found.

Hierarchy

Expanded class hierarchy of flag_broken

1 string reference to 'flag_broken'
flag_add_form_validate in includes/flag.admin.inc

File

includes/flag/flag_flag.inc, line 1619
Contains the flag_flag class. Flag type classes use an object oriented style inspired by that of Views 2.

View source
class flag_broken extends flag_flag {
  function options_form(&$form) {
    drupal_set_message(t("The module providing this flag wasn't found, or this flag type, %type, isn't valid.", array(
      '%type' => $this->entity_type,
    )), 'error');
    $form = array();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
flag_broken::options_form function Provides a form for setting options. Overrides flag_flag::options_form
flag_flag::$entity_type property The entity type this flag works with.
flag_flag::$errors public property An associative array containing textual errors that may be created during validation.
flag_flag::$fid property The database ID.
flag_flag::$global property Whether this flag state should act as a single toggle to all users.
flag_flag::$name property The flag's "machine readable" name.
flag_flag::$roles property The roles array. This can be populated by fetch_roles() when needed.
flag_flag::$title property The human-readable title for this flag.
flag_flag::$types property The sub-types, AKA bundles, this flag applies to.
flag_flag::access function Determines whether the user may flag, or unflag, the given entity.
flag_flag::access_entity_enabled function Utility function: Checks whether a flag applies to a certain type, and possibly subtype, of entity.
flag_flag::access_multiple function Determine access to multiple objects.
flag_flag::admin_path function Returns administrative menu path for carrying out some action.
flag_flag::applies_to_entity function Returns TRUE if the flag applies to the given entity. 1
flag_flag::applies_to_entity_id function Returns TRUE if the flag applies to the entity with the given ID.
flag_flag::construct function Default constructor. Loads the default options.
flag_flag::delete function Deletes a flag from the database.
flag_flag::disable function Disable a flag provided by a module.
flag_flag::enable function Enable a flag provided by a module.
flag_flag::factory_by_array static function Create a complete flag (except an FID) from an array definition.
flag_flag::factory_by_entity_type static function Another factory method. Returns a new, "empty" flag; e.g., one suitable for the "Add new flag" page.
flag_flag::factory_by_row static function Creates a flag from a database row. Returns it.
flag_flag::fetch_entity function Fetches, possibly from some cache, an entity this flag works with.
flag_flag::fetch_roles function Load this flag's role data from permissions.
flag_flag::find_default_flag function Finds the "default flag" corresponding to this flag.
flag_flag::flag function Flags, or unflags, an item. 1
flag_flag::flagging_delete private function Unflag an entity by deleting a Flagging.
flag_flag::flagging_insert private function Create a new Flagging to flag an entity.
flag_flag::flagging_update private function Update a Flagging.
flag_flag::form_input function Update the flag with settings entered in a form. 1
flag_flag::get_count function Returns the number of times an item is flagged.
flag_flag::get_entity_id function Given an entity, returns its ID. Derived classes must implement this. 1
flag_flag::get_errors function Returns an array of errors set during validation.
flag_flag::get_flagging function Similar to is_flagged() excepts it returns the flagging entity.
flag_flag::get_flagging_record function Returns the flagging record. 2
flag_flag::get_flag_action function Returns a 'flag action' object. It exists only for the sake of its informative tokens. Currently, it's utilized only for the 'mail' action. 1
flag_flag::get_label function Processes a flag label for display. This means language translation and token replacements.
flag_flag::get_labels_token_types function Returns the token types this flag understands in labels. These are used for narrowing down the token list shown in the help box to only the relevant ones. 1
flag_flag::get_link_type function Get the link type for this flag.
flag_flag::get_permissions function Provides permissions for this flag. 1
flag_flag::get_relevant_action_objects function Returns objects the action may possibly need. This method should return at least the 'primary' object the action operates on. 1
flag_flag::get_serialized_options function Options are stored serialized in the database.
flag_flag::get_title function A convenience method for getting the flag title.
flag_flag::get_user_count function Returns the number of items a user has flagged.
flag_flag::get_valid_actions function Returns an array of all actions that are executable with this flag.
flag_flag::get_views_info function Returns information needed for Views integration. E.g., the Views table holding the flagged object, its primary key, and various labels. See derived classes for examples. 1
flag_flag::insert function Saves a new flag to the database. Better use save().
flag_flag::invoke_rules_event protected function Invoke a Rules event in reaction to a flagging or unflagging. 1
flag_flag::is_compatible function Returns TRUE if this flag's declared API version is compatible with this module.
flag_flag::is_flagged function Determines if a certain user has flagged this object.
flag_flag::new_flagging function Construct a new, empty flagging entity object.
flag_flag::options function Declares the options this flag supports, and their default values. 1
flag_flag::remember_entity function Store an object in the flag handler's cache.
flag_flag::replace_tokens function Replaces tokens in a label. Only the 'global' token context is recognized by default, so derived classes should override this method to add all token contexts they understand. 1
flag_flag::revert function Reverts an overriding flag to its default state.
flag_flag::save function Saves a flag to the database. It is a wrapper around update() and insert().
flag_flag::shows_in_entity_links function Determine whether the flag should show a flag link in entity links. 1
flag_flag::theme function Renders a flag/unflag link.
flag_flag::theme_suggestions function Provides an array of possible themes to try for a given flag.
flag_flag::type_access function Implements access() implemented by each child class. 1
flag_flag::type_access_multiple function Implements access_multiple() implemented by each child class. 3
flag_flag::update function Saves an existing flag to the database. Better use save().
flag_flag::user_access function Determines whether the user has the permission to use this flag.
flag_flag::uses_anonymous_cookies function Returns TRUE if this flag requires anonymous user cookies.
flag_flag::validate function Validates this flag's options.
flag_flag::validate_access function Validates that the current flag's access settings are valid.
flag_flag::validate_name function Validates that the current flag's name is valid.
flag_flag::_decrease_count function Decreases the flag count for an object and clears the static counts cache.
flag_flag::_flag_anonymous function Set a cookie for anonymous users to record their flagging.
flag_flag::_flag_url function A shortcut function to output the link URL.
flag_flag::_increase_count function Increases the flag count for an object and clears the static counts cache.
flag_flag::_is_flagged function Determines if a certain user has flagged this object.
flag_flag::_load_entity function Loads an entity this flag works with. Derived classes must implement this. 1
flag_flag::_unflag_anonymous function Remove the cookie for anonymous users to record their unflagging.