You are here

Home » API reference » Linkit 7.3 » user.class.php

class LinkitSearchPluginUser in Linkit 7.3

Reprecents a Linkit user search plugin.

Hierarchy

Expanded class hierarchy of LinkitSearchPluginUser

File

plugins/linkit_search/user.class.php, line 10
Define Linkit user search plugin class.

View source 
class LinkitSearchPluginUser extends LinkitSearchPluginEntity {

  /**
   * Overrides LinkitSearchPluginEntity::__construct().
   */
  function __construct($plugin, $profile) {

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

}

Members

Namesort descending Modifiers Type Description Overrides
LinkitSearchPlugin::$plugin protected property The plugin definition for this instance.
LinkitSearchPlugin::$profile protected property The profile instance for this instance.
LinkitSearchPlugin::broken public function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 1
LinkitSearchPlugin::factory public static function Implements LinkitSearchPluginInterface::factory(). Overrides LinkitSearchPluginInterface::factory
LinkitSearchPlugin::ui_description public function Implements LinkitSearchPluginInterface::ui_description(). Overrides LinkitSearchPluginInterface::ui_description 2
LinkitSearchPlugin::ui_title public function Implements LinkitSearchPluginInterface::ui_title(). Overrides LinkitSearchPluginInterface::ui_title 2
LinkitSearchPluginEntity::$conf property Plugin specific settings.
LinkitSearchPluginEntity::$entity_field_label property The name of the property that contains the entity label.
LinkitSearchPluginEntity::$entity_info property The entity info array of an entity type.
LinkitSearchPluginEntity::$entity_key_bundle property The name of the property of the bundle object that contains the name of the bundle object.
LinkitSearchPluginEntity::$query property Entity field query instance.
LinkitSearchPluginEntity::buildSettingsForm function Overrides LinkitSearchPlugin::buildSettingsForm(). Overrides LinkitSearchPlugin::buildSettingsForm 3
LinkitSearchPluginEntity::createDescription function Create a search row description. 2
LinkitSearchPluginEntity::createGroup function Create a group text. 2
LinkitSearchPluginEntity::createLabel function Create a label of an entity.
LinkitSearchPluginEntity::createPath function Create an uri for an entity. 1
LinkitSearchPluginEntity::createRowClass function Create a row class to append to the search result row. 1
LinkitSearchPluginEntity::fetchResults public function Implements LinkitSearchPluginInterface::fetchResults(). Overrides LinkitSearchPluginInterface::fetchResults 1
LinkitSearchPluginEntity::getQueryInstance function Start a new EntityFieldQuery instance. 2
LinkitSearchPluginUser::__construct function Overrides LinkitSearchPluginEntity::__construct(). Overrides LinkitSearchPluginEntity::__construct