class LinkitPluginUser in Linkit 7.2

@file Define Linkit user plugin class.

Hierarchy

• class \LinkitPlugin implements LinkitPluginInterface
  • class \LinkitPluginEntity
    • class \LinkitPluginUser

File

plugins/linkit_plugins/linkit-plugin-user.class.php, line 6

Define Linkit user plugin class.

class LinkitPluginUser extends LinkitPluginEntity {
  function __construct($plugin, $profile) {

    /**
     * The user entity doesn't add any label in their entity keys as they define a
     * "label callback" instead. Therefor we have to tell which field the user
     * entity have as label.
     */
    $this->entity_field_label = 'name';
    parent::__construct($plugin, $profile);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LinkitPlugin::broken		function	Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found.	1
LinkitPlugin::buildRowClass		function	Returns a string with CSS classes that will be added to the search result row for this item.	1
LinkitPlugin::setSearchString		function	Set the search string.
LinkitPlugin::ui_description		function	Return a string representing this handler's description in the UI.	2
LinkitPlugin::ui_title		function	Return a string representing this handler's name in the UI.	2
LinkitPluginEntity::$conf		property	Plugin specific settings.
LinkitPluginEntity::$entity_field_label		property	The name of the property that contains the entity label.
LinkitPluginEntity::$entity_info		property	The entity info array of an entity type.
LinkitPluginEntity::$entity_key_bundle		property	The name of the property of the bundle object that contains the name of the bundle object.
LinkitPluginEntity::$query		property	Entity field query instance.
LinkitPluginEntity::autocomplete_callback		function	The autocomplete callback function for the Linkit Entity plugin. Overrides LinkitPluginInterface::autocomplete_callback	1
LinkitPluginEntity::buildDescription		function	Build the search row description. Overrides LinkitPlugin::buildDescription	1
LinkitPluginEntity::buildGroup		function	When "group_by_bundle" is active, we need to add the bundle name to the group, else just return the entity label. Overrides LinkitPlugin::buildGroup	2
LinkitPluginEntity::buildLabel		function	Build the label that will be used in the search result for each row. Overrides LinkitPlugin::buildLabel	1
LinkitPluginEntity::buildPath		function	Build an URL based in the path and the options. Overrides LinkitPlugin::buildPath	1
LinkitPluginEntity::buildReverseMenuTrail		function	Builds a reverse menu trail for the entity.
LinkitPluginEntity::buildSettingsForm		function	Generate a settings form for this handler. Uses the standard Drupal FAPI. The element will be attached to the "data" key. Overrides LinkitPlugin::buildSettingsForm	3
LinkitPluginEntity::getQueryInstance		function	Start a new EntityFieldQuery instance.	2
LinkitPluginUser::__construct		function	Initialize this plugin with the plugin, profile, and entity specific variables. Overrides LinkitPluginEntity::__construct