class userpoints_views_handler_argument_category in User Points 7

Argument handler to accept a userpoints category.

Hierarchy

• class \views_object
  • class \views_handler
    • class \views_handler_argument
      • class \userpoints_views_handler_argument_category

1 string reference to 'userpoints_views_handler_argument_category'

userpoints_views_data in ./userpoints.views.inc

Implements hook_views_data().

File

views/userpoints_views_handler_argument_category.inc, line 10

Views argument handler for the Userpoints category.

class userpoints_views_handler_argument_category extends views_handler_argument {
  function construct() {
    parent::construct('category');
  }

  /**
   * Override the behavior of summary_name(). Get the user friendly version
   * of the node type.
   */
  function summary_name($data) {
    return $this
      ->category($data->{$this->name_alias});
  }

  /**
   * Override the behavior of title(). Get the user friendly version of the
   * node type.
   */
  function title() {
    return $this
      ->category($this->argument);
  }
  function category($id) {
    $output = userpoints_get_categories();
    if (empty($output[$id])) {
      $output = t('Unknown category');
    }
    return check_plain($output[$id]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
userpoints_views_handler_argument_category::category		function
userpoints_views_handler_argument_category::construct		function	Views handlers use a special construct function. Overrides views_handler_argument::construct
userpoints_views_handler_argument_category::summary_name		function	Override the behavior of summary_name(). Get the user friendly version of the node type. Overrides views_handler_argument::summary_name
userpoints_views_handler_argument_category::title		function	Override the behavior of title(). Get the user friendly version of the node type. Overrides views_handler_argument::title
views_handler::$handler_type	public	property	The type of the handler, for example filter/footer/field.
views_handler::$query	public	property	Where the $query object will reside:.	1
views_handler::$real_field	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship	public	property	The relationship used for this field.
views_handler::$table_alias	public	property	The alias of the table of this handler which is used in the query.
views_handler::$view	public	property	The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input	public	function	Take input from exposed handlers and assign to this handler, if necessary.	1
views_handler::access	public	function	Check whether current user has access to this handler.	10
views_handler::admin_summary	public	function	Provide text for the administrative summary.	4
views_handler::broken	public	function	Determine if the handler is considered 'broken'.	6
views_handler::can_expose	public	function	Determine if a handler can be exposed.	2
views_handler::case_transform	public	function	Transform a string by a certain method.
views_handler::ensure_my_table	public	function	Ensure the main table for this handler is in the query. This is used a lot.	8
views_handler::exposed_form	public	function	Render our chunk of the exposed handler form when selecting.	1
views_handler::exposed_info	public	function	Get information about the exposed form for the form renderer.	1
views_handler::exposed_submit	public	function	Submit the exposed handler form.
views_handler::exposed_validate	public	function	Validate the exposed handler form.	4
views_handler::expose_form	public	function	Form for exposed handler options.	2
views_handler::expose_options	public	function	Set new exposed option defaults when exposed setting is flipped on.	2
views_handler::expose_submit	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate	public	function	Validate the options form.	1
views_handler::extra_options	public	function	Provide defaults for the handler.
views_handler::extra_options_form	public	function	Provide a form for setting options.	1
views_handler::extra_options_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate	public	function	Validate the options form.
views_handler::get_field	public	function	Shortcut to get a handler's raw field value.
views_handler::get_join	public	function	Get the join object that should be used for this handler.
views_handler::groupby_form	public	function	Provide a form for aggregation settings.	1
views_handler::groupby_form_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
views_handler::has_extra_options	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
views_handler::is_a_group	public	function	Returns TRUE if the exposed filter works like a grouped filter.	1
views_handler::is_exposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input	public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.	1
views_handler::placeholder	public	function	Provides a unique placeholders for handlers.
views_handler::post_execute	public	function	Run after the view is executed, before the result is cached.	1
views_handler::pre_query	public	function	Run before the view is built.	1
views_handler::sanitize_value	public	function	Sanitize the value for output.
views_handler::set_relationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button	public	function	Shortcut to display the expose/hide button.	2
views_handler::show_expose_form	public	function	Shortcut to display the exposed options form.
views_handler::store_exposed_input	public	function	If set to remember exposed input in the session, store it there.	1
views_handler::ui_name	public	function	Return a string representing this handler's name in the UI.	9
views_handler::use_group_by	public	function	Provides the handler some groupby.	2
views_handler::validate	public	function	Validates the handler against the complete View.	1
views_handler_argument::$argument	public	property
views_handler_argument::$name_field	public	property	The field to use for the name to use in the summary.
views_handler_argument::$name_table	public	property	The table to use for the name, if not the same table as the argument.
views_handler_argument::$validator	public	property
views_handler_argument::$value	public	property		1
views_handler_argument::default_access_denied	public	function	Default action: access denied.
views_handler_argument::default_action	public	function	Handle the default action, which means our argument wasn't present.
views_handler_argument::default_actions	public	function	List of default behaviors for this argument if the argument is not present.	4
views_handler_argument::default_argument_form	public	function	Provide a form for selecting the default argument.	1
views_handler_argument::default_default	public	function	This just returns true.
views_handler_argument::default_empty	public	function	Default action: empty.
views_handler_argument::default_ignore	public	function	Default action: ignore.
views_handler_argument::default_not_found	public	function	Default action: not found.
views_handler_argument::default_summary	public	function	Default action: summary.
views_handler_argument::default_summary_form	public	function	Form for selecting further summary options.
views_handler_argument::exception_title	public	function	Work out which title to use.
views_handler_argument::export_plugin	public	function	Generic plugin export handler.	1
views_handler_argument::export_summary	public	function	Export handler for summary export.
views_handler_argument::export_validation	public	function	Export handler for validation export.
views_handler_argument::get_default_argument	public	function	Get a default argument, if available.	1
views_handler_argument::get_plugin	public	function	Get the display or row plugin, if it exists.
views_handler_argument::get_sort_name	public	function	Return a description of how the argument would normally be sorted.	5
views_handler_argument::get_title	public	function	Called by the view object to get the title.
views_handler_argument::get_value	public	function	Get the value of this argument.
views_handler_argument::has_default_argument	public	function	Determine if the argument is set to provide a default argument.
views_handler_argument::init	public	function	Init the handler with necessary data. Overrides views_handler::init	3
views_handler_argument::is_exception	public	function
views_handler_argument::needs_style_plugin	public	function	Determine if the argument needs a style plugin. Overrides views_handler::needs_style_plugin
views_handler_argument::options_form	public	function	Build the options form. Overrides views_handler::options_form	8
views_handler_argument::options_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_handler::options_submit
views_handler_argument::options_validate	public	function	Validate the options form. Overrides views_handler::options_validate
views_handler_argument::option_definition	public	function	Information about options for all kinds of purposes will be held here. Overrides views_handler::option_definition	6
views_handler_argument::process_summary_arguments	public	function	Process the summary arguments for display.
views_handler_argument::query	public	function	Set up the query for this argument.	12
views_handler_argument::set_argument	public	function	Set the input for this argument.
views_handler_argument::set_breadcrumb	public	function	Give an argument the opportunity to modify the breadcrumb, if it wants.	3
views_handler_argument::summary_argument	public	function	Provide the argument to use to link from the summary to the next level.	4
views_handler_argument::summary_basics	public	function	Some basic summary behavior.
views_handler_argument::summary_name_field	public	function	Add the name field, which is the field displayed in summary queries.
views_handler_argument::summary_query	public	function	Build the info for the summary query.	3
views_handler_argument::summary_sort	public	function	Sorts the summary based upon the user's selection.
views_handler_argument::uses_breadcrumb	public	function	Determine if the argument can generate a breadcrumb.
views_handler_argument::validate_arg	public	function	Validate that this argument works. By default, all arguments are valid.
views_handler_argument::validate_argument	public	function	Called by the menu system to validate an argument.
views_handler_argument::validate_argument_basic	public	function	Provide a basic argument validation.	1
views_handler_argument::validate_fail	public	function	How to act if validation fails.
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function