Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\field;
Chris@0: 
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityInterface;
Chris@0: use Drupal\Core\Field\FieldStorageDefinitionInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides an interface defining a field storage entity.
Chris@0:  */
Chris@0: interface FieldStorageConfigInterface extends ConfigEntityInterface, FieldStorageDefinitionInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the field type.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The field type, i.e. the id of a field type plugin. For example 'text'.
Chris@0:    */
Chris@0:   public function getType();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the name of the module providing the field type.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The name of the module that provides the field type.
Chris@0:    */
Chris@0:   public function getTypeProvider();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the list of bundles where the field storage has fields.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An array of bundle names.
Chris@0:    */
Chris@0:   public function getBundles();
Chris@0: 
Chris@0:   /**
Chris@0:    * Checks if the field storage can be deleted.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the field storage can be deleted.
Chris@0:    */
Chris@0:   public function isDeletable();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns whether the field storage is locked or not.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    *   TRUE if the field storage is locked.
Chris@0:    */
Chris@0:   public function isLocked();
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the locked flag.
Chris@0:    *
Chris@0:    * @param bool $locked
Chris@0:    *   Sets value of locked flag.
Chris@0:    *
Chris@0:    * @return $this
Chris@0:    */
Chris@0:   public function setLocked($locked);
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the maximum number of items allowed for the field.
Chris@0:    *
Chris@0:    * @param int $cardinality
Chris@0:    *   The cardinality value.
Chris@0:    *
Chris@0:    * @return $this
Chris@0:    */
Chris@0:   public function setCardinality($cardinality);
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the value for a field setting by name.
Chris@0:    *
Chris@0:    * @param string $setting_name
Chris@0:    *   The name of the setting.
Chris@0:    * @param mixed $value
Chris@0:    *   The value of the setting.
Chris@0:    *
Chris@0:    * @return $this
Chris@0:    */
Chris@0:   public function setSetting($setting_name, $value);
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets field storage settings.
Chris@0:    *
Chris@0:    * Note that the method does not unset existing settings not specified in the
Chris@0:    * incoming $settings array.
Chris@0:    *
Chris@0:    * For example:
Chris@0:    * @code
Chris@0:    *   // Given these are the default settings.
Chris@0:    *   $storage_definition->getSettings() === [
Chris@0:    *     'fruit' => 'apple',
Chris@0:    *     'season' => 'summer',
Chris@0:    *   ];
Chris@0:    *   // Change only the 'fruit' setting.
Chris@0:    *   $storage_definition->setSettings(['fruit' => 'banana']);
Chris@0:    *   // The 'season' setting persists unchanged.
Chris@0:    *   $storage_definition->getSettings() === [
Chris@0:    *     'fruit' => 'banana',
Chris@0:    *     'season' => 'summer',
Chris@0:    *   ];
Chris@0:    * @endcode
Chris@0:    *
Chris@0:    * For clarity, it is preferred to use setSetting() if not all available
Chris@0:    * settings are supplied.
Chris@0:    *
Chris@0:    * @param array $settings
Chris@0:    *   The array of storage settings.
Chris@0:    *
Chris@0:    * @return $this
Chris@0:    */
Chris@0:   public function setSettings(array $settings);
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets whether the field is translatable.
Chris@0:    *
Chris@0:    * @param bool $translatable
Chris@0:    *   Whether the field is translatable.
Chris@0:    *
Chris@0:    * @return $this
Chris@0:    */
Chris@0:   public function setTranslatable($translatable);
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the custom storage indexes for the field data storage.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An array of custom indexes.
Chris@0:    */
Chris@0:   public function getIndexes();
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the custom storage indexes for the field data storage..
Chris@0:    *
Chris@0:    * @param array $indexes
Chris@0:    *   The array of custom indexes.
Chris@0:    *
Chris@0:    * @return $this
Chris@0:    */
Chris@0:   public function setIndexes(array $indexes);
Chris@0: 
Chris@0: }