class SearchApiSort in Search API sorts 7

Class representing a search sort.

Hierarchy

• class \Entity implements EntityInterface
  • class \SearchApiSort

1 string reference to 'SearchApiSort'

search_api_sorts_entity_info in ./search_api_sorts.module

Implements hook_entity_info().

File

./search_api_sorts.entity.inc, line 11

The Search API sort entity definition.

class SearchApiSort extends Entity {

  /* Database values that will be set when object is loaded: */

  /**
   * The Search API sort id.
   *
   * @var integer
   */
  public $id = 0;

  /**
   * The Search API sort index id.
   *
   * @var string
   */
  public $index_id = '';

  /**
   * The Search API sort field name.
   *
   * @var string
   */
  public $field = '';

  /**
   * The Search API sort name.
   *
   * @var string
   */
  public $name = '';

  /**
   * The Search API sort is enabled.
   *
   * @var integer
   */
  public $enabled = 0;

  /**
   * The Search API sort weight.
   *
   * @var integer
   */
  public $weight = 0;

  /**
   * Constructor as a helper to the parent constructor.
   */
  public function __construct(array $values = array()) {
    parent::__construct($values, 'search_api_sort');
    if (empty($this->options['field_name'])) {
      $index = search_api_index_load($this->index_id);
      if (is_object($index)) {
        $fields = $index
          ->getFields();
        $this->options['field_name'] = isset($fields[$this->field]['name']) ? $fields[$this->field]['name'] : $this->field;
      }
      else {
        $this->options['field_name'] = $this->field;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	protected	property
Entity::buildContent	public	function	Builds a structured array representing the entity's content. Overrides EntityInterface::buildContent	1
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used.	1
Entity::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info().
Entity::delete	public	function	Permanently deletes the entity. Overrides EntityInterface::delete
Entity::entityInfo	public	function	Returns the info of the type of the entity. Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Returns the type of the entity. Overrides EntityInterface::entityType
Entity::export	public	function	Exports the entity. Overrides EntityInterface::export
Entity::getTranslation	public	function	Gets the raw, translated value of a property or field. Overrides EntityInterface::getTranslation
Entity::hasStatus	public	function	Checks if the entity has a certain exportable status. Overrides EntityInterface::hasStatus
Entity::identifier	public	function	Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface::identifier
Entity::internalIdentifier	public	function	Returns the internal, numeric identifier. Overrides EntityInterface::internalIdentifier
Entity::isDefaultRevision	public	function	Checks whether the entity is the default revision. Overrides EntityInterface::isDefaultRevision
Entity::label	public	function	Returns the label of the entity. Overrides EntityInterface::label
Entity::save	public	function	Permanently saves the entity. Overrides EntityInterface::save
Entity::setUp	protected	function	Set up the object instance on construction or unserializiation.
Entity::uri	public	function	Returns the uri of the entity just as entity_uri(). Overrides EntityInterface::uri
Entity::view	public	function	Generate an array for rendering the entity. Overrides EntityInterface::view
Entity::wrapper	public	function	Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface::wrapper
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
SearchApiSort::$enabled	public	property	The Search API sort is enabled.
SearchApiSort::$field	public	property	The Search API sort field name.
SearchApiSort::$id	public	property	The Search API sort id.
SearchApiSort::$index_id	public	property	The Search API sort index id.
SearchApiSort::$name	public	property	The Search API sort name.
SearchApiSort::$weight	public	property	The Search API sort weight.
SearchApiSort::__construct	public	function	Constructor as a helper to the parent constructor. Overrides Entity::__construct