interface SolrFieldTypeInterface in Search API Solr 4.x
Same name and namespace in other branches
- 8.3 src/SolrFieldTypeInterface.php \Drupal\search_api_solr\SolrFieldTypeInterface
- 8.2 src/SolrFieldTypeInterface.php \Drupal\search_api_solr\SolrFieldTypeInterface
Provides an interface defining a SolrFieldType entity.
Hierarchy
- interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\search_api_solr\SolrConfigInterface
- interface \Drupal\search_api_solr\SolrFieldTypeInterface
- interface \Drupal\search_api_solr\SolrConfigInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
Expanded class hierarchy of SolrFieldTypeInterface
All classes that implement SolrFieldTypeInterface
3 files declare their use of SolrFieldTypeInterface
- SolrFieldType.php in src/
Entity/ SolrFieldType.php - SolrFieldTypeListBuilder.php in src/
Controller/ SolrFieldTypeListBuilder.php - Utility.php in src/
Utility/ Utility.php
File
- src/
SolrFieldTypeInterface.php, line 8
Namespace
Drupal\search_api_solrView source
interface SolrFieldTypeInterface extends SolrConfigInterface {
/**
* Gets the Solr Field Type name.
*
* @return string
* The Solr Field Type name.
*/
public function getFieldTypeName();
/**
* Gets the custom code targeted by this Solr Field Type.
*
* @return string
* Custom code.
*/
public function getCustomCode();
/**
* Gets the language targeted by this Solr Field Type.
*
* @return string
* Language code.
*/
public function getFieldTypeLanguageCode();
/**
* Gets the domains the field type is suitable for.
*
* @return string[]
* An array of domains as strings.
*/
public function getDomains();
/**
* Gets the Solr Field Type definition as nested associative array.
*
* @return array
* The Solr Field Type definition as nested associative array.
*/
public function getFieldType();
/**
* Sets the Solr Field Type definition as nested associative array.
*
* @param array $field_type
* The Solr Field Type definition as nested associative array.
*
* @return self
* Field type.
*/
public function setFieldType(array $field_type);
/**
* Gets the Solr Field Type definition as JSON.
*
* The JSON format is used to interact with a managed Solr schema.
*
* @param bool $pretty
* Return pretty printed JSON.
*
* @return string
* The Solr Field Type definition as JSON.
*/
public function getFieldTypeAsJson(bool $pretty = FALSE);
/**
* Sets the Solr Field Type definition as JSON.
*
* Decodes the Solr Field Type definition encoded as JSON and stores an
* nested associative array internally. This method in useful to import a
* field type from an existing Solr server.
*
* @param string $field_type
* The Solr Field Type definition as JSON.
*
* @return self
* Field type as json.
*/
public function setFieldTypeAsJson($field_type);
/**
* Gets the Solr Spellcheck Field Type definition as nested associative array.
*
* @return array|null
* The Solr SpellcheckField Type definition as nested associative array or
* NULL if it doesn't exist.
*/
public function getSpellcheckFieldType();
/**
* Sets the Solr Spellcheck Field Type definition as nested associative array.
*
* @param array $spellcheck_field_type
* The Solr SpellcheckField Type definition as nested associative array.
*
* @return self
* Spellcheck field type.
*/
public function setSpellcheckFieldType(array $spellcheck_field_type);
/**
* Gets the Solr Spellcheck Field Type definition as JSON.
*
* The JSON format is used to interact with a managed Solr schema.
*
* @param bool $pretty
* Return pretty printed JSON.
*
* @return string
* The Solr Spellcheck Field Type definition as JSON.
*/
public function getSpellcheckFieldTypeAsJson(bool $pretty = FALSE);
/**
* Sets the Solr Spellcheck Field Type definition as JSON.
*
* Decodes the Solr Field Type definition encoded as JSON and stores an
* nested associative array internally. This method in useful to import a
* field type from an existing Solr server.
*
* @param string $spellcheck_field_type
* The Solr Spellcheck Field Type definition as JSON, might be empty if it
* doesn't exist.
*
* @return self
* Spellcheck field type as json.
*/
public function setSpellcheckFieldTypeAsJson($spellcheck_field_type);
/**
* Gets the Solr Spellcheck Spellcheck Field Type definition as XML fragment.
*
* The XML format is used as part of a classic Solr schema.
*
* @param bool $add_comment
* Wether to add a comment to the XML or not to explain the purpose of this
* Solr Field Type.
*
* @return string
* The Solr Spellcheck Field Type definition as XML, might be empty if it
* doesn't exist.
*/
public function getSpellcheckFieldTypeAsXml($add_comment = TRUE);
/**
* Gets the Solr Collated Field Type definition as nested associative array.
*
* @return array|null
* The Solr Collated Type definition as nested associative array or
* NULL if it doesn't exist.
*/
public function getCollatedFieldType();
/**
* Sets the Solr Collated Field Type definition as nested associative array.
*
* @param array $collated_field_type
* The Solr Collated Type definition as nested associative array.
*
* @return self
* Collated field type
*/
public function setCollatedFieldType(array $collated_field_type);
/**
* Gets the Solr Collated Field Type definition as JSON.
*
* The JSON format is used to interact with a managed Solr schema.
*
* @param bool $pretty
* Return pretty printed JSON.
*
* @return string
* The Solr Spellcheck Field Type definition as JSON.
*/
public function getCollatedFieldTypeAsJson(bool $pretty = FALSE);
/**
* Sets the Solr Collated Field Type definition as JSON.
*
* Decodes the Solr Field Type definition encoded as JSON and stores an
* nested associative array internally. This method in useful to import a
* field type from an existing Solr server.
*
* @param string $collated_field_type
* The Solr Spellcheck Field Type definition as JSON, might be empty if it
* doesn't exist.
*
* @return self
* Collated field type as json.
*/
public function setCollatedFieldTypeAsJson($collated_field_type);
/**
* Gets the Solr Collated Field Type definition as XML fragment.
*
* The XML format is used as part of classic Solr schema.
*
* @param bool $add_comment
* Wether to add a comment to the XML or not to explain the purpose of thid
* Solr Field Type.
*
* @return string
* The Solr Collated Field Type definition as XML, might be empty
* if it doesn't exist.
*/
public function getCollatedFieldTypeAsXml($add_comment = TRUE);
/**
* Gets the Solr Unstemmed Field Type definition as nested associative array.
*
* @return array|null
* The Solr Unstemmed Field Type definition as nested associative array or
* NULL if it doesn't exist.
*/
public function getUnstemmedFieldType();
/**
* Sets the Solr Unstemmed Field Type definition as nested associative array.
*
* @param array $unstemmed_field_type
* The Solr Unstemmed Field Type definition as nested associative array.
*
* @return self
* Unstemmed field type.
*/
public function setUnstemmedFieldType(array $unstemmed_field_type);
/**
* Gets the Solr Unstemmed Field Type definition as JSON.
*
* The JSON format is used to interact with a managed Solr schema.
*
* @param bool $pretty
* Return pretty printed JSON.
*
* @return string
* The Solr Unstemmed Field Type definition as JSON.
*/
public function getUnstemmedFieldTypeAsJson(bool $pretty = FALSE);
/**
* Sets the Solr Unstemmed Field Type definition as JSON.
*
* Decodes the Solr Field Type definition encoded as JSON and stores an
* nested associative array internally. This method in useful to import a
* field type from an existing Solr server.
*
* @param string $unstemmed_field_type
* The Solr Unstemmed Field Type definition as JSON, might be empty if it
* doesn't exist.
*
* @return self
* Untemmed field type as json.
*/
public function setUnstemmedFieldTypeAsJson($unstemmed_field_type);
/**
* Gets the Solr Unstemmed Field Type definition as XML fragment.
*
* The XML format is used as part of classic Solr schema.
*
* @param bool $add_comment
* Wether to add a comment to the XML or not to explain the purpose of this
* Solr Field Type.
*
* @return string
* The Solr Unstemmed Field Type definition as XML, might be empty if it
* doesn't exist.
*/
public function getUnstemmedFieldTypeAsXml($add_comment = TRUE);
/**
* Gets a list of dynamic Solr fields that will use this Solr Field Type.
*
* @param int|null $solr_major_version
*
* @return array
* An array of dynamic field definitions.
*/
public function getDynamicFields(?int $solr_major_version = NULL);
/**
* Gets a list of static fields that will use this Solr Field Type.
*
* @return array
* An array of static field definitions.
*/
public function getStaticFields();
/**
* Gets a list of copy fields.
*
* @return array
* An array of copy field definitions. A copy field definition consists of
* arrays like ['source' => 'fieldA', 'dest' => 'fieldB'].
*/
public function getCopyFields();
/**
* Gets all text files required by the Solr Field Type definition.
*
* @return array
* An array of text files required by the Solr Field Type definition.
*/
public function getTextFiles();
/**
* Adds a single text file to the Solr Field Type.
*
* @param string $name
* The name of the text file.
* @param string $content
* The content of the text file.
*/
public function addTextFile($name, $content);
/**
* Adds multiple text files to the Solr Field Type.
*
* @param array $text_files
* An associative array using the file names as keys and the file contents
* as values.
*
* @return self
* Text File.
*/
public function setTextFiles(array $text_files);
/**
* Indicates if the field type requires a managed Solr schema.
*
* @return bool
* Whether the field type requires a managed schema.
*/
public function requiresManagedSchema();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 9 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 27 |
ConfigEntityInterface:: |
public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface:: |
public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface:: |
public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface:: |
public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface:: |
public | function | Sets the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface:: |
public | function | Sets that the data should be trusted. | 2 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Gets an array of all property values. | 3 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
SolrConfigInterface:: |
public | function | Gets the Solr Entity definition as XML fragment. | 4 |
SolrConfigInterface:: |
public | function | Gets the minimum Solr version that is supported by this Solr Field Type. | 1 |
SolrConfigInterface:: |
public | function | Gets the Solr Entity name. | 1 |
SolrConfigInterface:: |
public | function | Gets the identifier that describes Solr Entity's purpose. | 1 |
SolrConfigInterface:: |
public | function | Gets the Solr Field Type specific additions to solrconfig.xml as array. | 1 |
SolrConfigInterface:: |
public | function | Gets the Solr Field Type specific additions to solrconfig.xml as XML. | 1 |
SolrConfigInterface:: |
public | function | Indicates if a Config Entity is recommended to be used. | 1 |
SolrConfigInterface:: |
public | function | Sets the minimum Solr version that is supported by this Solr Field Type. | 1 |
SolrConfigInterface:: |
public | function | Sets the Solr Field Type specific additions to solrconfig.xml as array. | 1 |
SolrFieldTypeInterface:: |
public | function | Adds a single text file to the Solr Field Type. | |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Collated Field Type definition as nested associative array. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Collated Field Type definition as JSON. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Collated Field Type definition as XML fragment. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets a list of copy fields. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the custom code targeted by this Solr Field Type. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the domains the field type is suitable for. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets a list of dynamic Solr fields that will use this Solr Field Type. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Field Type definition as nested associative array. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Field Type definition as JSON. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the language targeted by this Solr Field Type. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Field Type name. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Spellcheck Field Type definition as nested associative array. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Spellcheck Field Type definition as JSON. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Spellcheck Spellcheck Field Type definition as XML fragment. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets a list of static fields that will use this Solr Field Type. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets all text files required by the Solr Field Type definition. | |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Unstemmed Field Type definition as nested associative array. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Unstemmed Field Type definition as JSON. | 1 |
SolrFieldTypeInterface:: |
public | function | Gets the Solr Unstemmed Field Type definition as XML fragment. | 1 |
SolrFieldTypeInterface:: |
public | function | Indicates if the field type requires a managed Solr schema. | 1 |
SolrFieldTypeInterface:: |
public | function | Sets the Solr Collated Field Type definition as nested associative array. | 1 |
SolrFieldTypeInterface:: |
public | function | Sets the Solr Collated Field Type definition as JSON. | 1 |
SolrFieldTypeInterface:: |
public | function | Sets the Solr Field Type definition as nested associative array. | 1 |
SolrFieldTypeInterface:: |
public | function | Sets the Solr Field Type definition as JSON. | 1 |
SolrFieldTypeInterface:: |
public | function | Sets the Solr Spellcheck Field Type definition as nested associative array. | 1 |
SolrFieldTypeInterface:: |
public | function | Sets the Solr Spellcheck Field Type definition as JSON. | 1 |
SolrFieldTypeInterface:: |
public | function | Adds multiple text files to the Solr Field Type. | |
SolrFieldTypeInterface:: |
public | function | Sets the Solr Unstemmed Field Type definition as nested associative array. | 1 |
SolrFieldTypeInterface:: |
public | function | Sets the Solr Unstemmed Field Type definition as JSON. | 1 |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | 1 |
ThirdPartySettingsInterface:: |
public | function | Gets the list of third parties that store information. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets all third-party settings of a given module. | 5 |
ThirdPartySettingsInterface:: |
public | function | Sets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Unsets a third-party setting. | 5 |