You are here

Home » API reference » Search API sorts 8 » SearchApiSortsField.php

class SearchApiSortsField in Search API sorts 8

Defines the Search api sorts index configuration entity.

Plugin annotation


@ConfigEntityType(
  id = "search_api_sorts_field",
  label = @Translation("Search api sorts field"),
  admin_permission = "administer search_api",
  config_prefix = "search_api_sorts_field",
  entity_keys = {
    "id" = "id",
    "weight" = "weight",
    "label" = "label"
  },
  config_export = {
    "id",
    "display_id",
    "field_identifier",
    "status",
    "default_sort",
    "default_order",
    "label",
    "weight",
  },
  links = {
    "edit-form" = "/admin/config/search/search-api/sorts/{search_api_sorts_field}",
  },
  lookup_keys = {
    "display_id",
    "status"
  }
)

Hierarchy

Expanded class hierarchy of SearchApiSortsField

4 files declare their use of SearchApiSortsField
AdminController.php in src/Controller/AdminController.php
ManageSortFieldsForm.php in src/Form/ManageSortFieldsForm.php
SearchApiSortsManagerTest.php in tests/src/Unit/SearchApiSortsManagerTest.php
SearchApiSortsUpdate8103Test.php in tests/src/Functional/Update/SearchApiSortsUpdate8103Test.php

File

src/Entity/SearchApiSortsField.php, line 39

Namespace

Drupal\search_api_sorts\Entity
View source 
class SearchApiSortsField extends ConfigEntityBase {

  /**
   * The ID of the search api sorts field.
   *
   * @var string
   */
  protected $id;

  /**
   * The ID of the search display.
   *
   * @var string
   */
  protected $display_id;

  /**
   * The field identifier of the search api sorts field.
   *
   * @var string
   */
  protected $field_identifier;

  /**
   * The status of the search api sorts field.
   *
   * @var bool
   */
  protected $status;

  /**
   * The default sort of the search api sorts field.
   *
   * Returns TRUE when this field is the default sorting field for this display.
   *
   * @var bool
   */
  protected $default_sort;

  /**
   * The default order of the search api sorts field.
   *
   * @var string
   */
  protected $default_order;

  /**
   * The label of the search api sorts field.
   *
   * @var string
   */
  protected $label;

  /**
   * The weight of the search api sorts field.
   *
   * @var int
   */
  protected $weight;

  /**
   * Returns the ID of the sorts field.
   *
   * @return string
   *   The ID of the sorts field.
   */
  public function getId() {
    return $this->id;
  }

  /**
   * Returns the id of the associated display.
   *
   * @return string
   *   The id of the associated display.
   */
  public function getDisplayId() {
    return $this->display_id;
  }

  /**
   * Sets the id of the associated display.
   *
   * @param string $display_id
   *   The id of the associated display.
   */
  public function setDisplayId($display_id) {
    $this->display_id = $display_id;
  }

  /**
   * Returns the field's identifier.
   *
   * @return string
   *   The field's identifier.
   */
  public function getFieldIdentifier() {
    return $this->field_identifier;
  }

  /**
   * Returns the field's identifier.
   *
   * @param string $field_identifier
   *   The field's identifier.
   */
  public function setFieldIdentifier($field_identifier) {
    $this->field_identifier = $field_identifier;
  }

  /**
   * Returns the status of the field.
   *
   * @return bool
   *   The status of the field.
   */
  public function getStatus() {
    return $this->status;
  }

  /**
   * Sets the status of the field.
   *
   * @param bool $status
   *   The status of the field.
   */
  public function setStatus($status) {
    $this->status = $status;
  }

  /**
   * Returns field is the default sorts.
   *
   * @return bool
   *   Field is the default sorts.
   */
  public function getDefaultSort() {
    return $this->default_sort;
  }

  /**
   * Sets the default sorts flag.
   *
   * @param bool $default_sort
   *   Field is the default sorts.
   */
  public function setDefaultSort($default_sort) {
    $this->default_sort = $default_sort;
  }

  /**
   * Returns the label of the sorts field.
   *
   * @return string
   *   The label of the sorts field.
   */
  public function getLabel() {
    return $this->label;
  }

  /**
   * Sets the label of the sorts field.
   *
   * @param string $label
   *   The label of the sorts field.
   */
  public function setLabel($label) {
    $this->label = $label;
  }

  /**
   * Returns the default order of the sorts field.
   *
   * @return string
   *   The default order of the sorts field.
   */
  public function getDefaultOrder() {
    return $this->default_order;
  }

  /**
   * Sets the default order of the sorts field.
   *
   * @param string $default_order
   *   The default order of the sorts field.
   */
  public function setDefaultOrder($default_order) {
    $this->default_order = $default_order;
  }

  /**
   * Returns the weight of the sorting field.
   *
   * @return int
   *   The weight of the sorting field.
   */
  public function getWeight() {
    return $this->weight;
  }

  /**
   * Sets the weight of the sorting field.
   *
   * @param int $weight
   *   The weight of the sorting field.
   */
  public function setWeight($weight) {
    $this->weight = $weight;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SearchApiSortsField::$default_order protected property The default order of the search api sorts field.
SearchApiSortsField::$default_sort protected property The default sort of the search api sorts field.
SearchApiSortsField::$display_id protected property The ID of the search display.
SearchApiSortsField::$field_identifier protected property The field identifier of the search api sorts field.
SearchApiSortsField::$id protected property The ID of the search api sorts field.
SearchApiSortsField::$label protected property The label of the search api sorts field.
SearchApiSortsField::$status protected property The status of the search api sorts field. Overrides ConfigEntityBase::$status
SearchApiSortsField::$weight protected property The weight of the search api sorts field.
SearchApiSortsField::getDefaultOrder public function Returns the default order of the sorts field.
SearchApiSortsField::getDefaultSort public function Returns field is the default sorts.
SearchApiSortsField::getDisplayId public function Returns the id of the associated display.
SearchApiSortsField::getFieldIdentifier public function Returns the field's identifier.
SearchApiSortsField::getId public function Returns the ID of the sorts field.
SearchApiSortsField::getLabel public function Returns the label of the sorts field.
SearchApiSortsField::getStatus public function Returns the status of the field.
SearchApiSortsField::getWeight public function Returns the weight of the sorting field.
SearchApiSortsField::setDefaultOrder public function Sets the default order of the sorts field.
SearchApiSortsField::setDefaultSort public function Sets the default sorts flag.
SearchApiSortsField::setDisplayId public function Sets the id of the associated display.
SearchApiSortsField::setFieldIdentifier public function Returns the field's identifier.
SearchApiSortsField::setLabel public function Sets the label of the sorts field.
SearchApiSortsField::setStatus public function Sets the status of the field. Overrides ConfigEntityBase::setStatus
SearchApiSortsField::setWeight public function Sets the weight of the sorting field.
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function