class MinisiteItem in Mini site 8

Plugin implementation of the Minisite field type.

Plugin annotation


@FieldType(
  id = "minisite",
  label = @Translation("Minisite"),
  description = @Translation("Stores the ID, path and optional blob of a minisite file."),
  category = @Translation("Reference"),
  default_widget = "minisite_default",
  default_formatter = "minisite_link",
  cardinality = 1,
  list_class = "\Drupal\minisite\Plugin\Field\FieldType\MinisiteItemList",
  constraints = {"ReferenceAccess" = {}, "FileValidation" = {}}
)

Hierarchy

class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
  - class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
    class \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem implements PreconfiguredFieldUiOptionsInterface, OptionsProviderInterface
    class \Drupal\file\Plugin\Field\FieldType\FileItem
    class \Drupal\minisite\Plugin\Field\FieldType\MinisiteItem uses StringTranslationTrait

Expanded class hierarchy of MinisiteItem

File

src/Plugin/Field/FieldType/MinisiteItem.php, line 31

Namespace

Drupal\minisite\Plugin\Field\FieldType

View source

class MinisiteItem extends FileItem {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    $defaults = [
      'file_extensions' => MinisiteInterface::SUPPORTED_ARCHIVE_EXTENSIONS,
      'file_directory' => MinisiteInterface::ARCHIVE_UPLOAD_DIR,
      'minisite_extensions' => MinisiteInterface::ALLOWED_EXTENSIONS,
      'description_field' => TRUE,
    ];
    $settings = $defaults + parent::defaultFieldSettings();
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'target_id' => [
          'description' => 'The ID of the file entity.',
          'type' => 'int',
          'unsigned' => TRUE,
        ],
        'description' => [
          'description' => 'A description of the file.',
          'type' => 'text',
        ],
        'asset_path' => [
          'description' => 'The URI of the entry point minisite asset path (index.html).',
          'type' => 'varchar',
          'length' => 255,
        ],
        'options' => [
          'description' => 'Serialized array of options for the link.',
          'type' => 'blob',
          'size' => 'big',
          'serialize' => TRUE,
        ],
        'alias_status' => [
          'type' => 'int',
          'size' => 'tiny',
          'not null' => TRUE,
          'default' => 0,
        ],
      ],
      'indexes' => [
        'target_id' => [
          'target_id',
        ],
        'asset_path' => [
          'asset_path',
        ],
      ],
      'foreign keys' => [
        'target_id' => [
          'table' => 'file_managed',
          'columns' => [
            'target_id' => 'fid',
          ],
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties = parent::propertyDefinitions($field_definition);

    // Remove properties set by the parent class.
    unset($properties['display']);
    $properties['asset_path'] = DataDefinition::create('string')
      ->setLabel(t('Minisite asset path'));
    $properties['options'] = MapDataDefinition::create()
      ->setLabel(t('Options'));
    $properties['alias_status'] = DataDefinition::create('boolean')
      ->setLabel(t('Minisite URL alias status'));
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
    $element = [];

    // We need the field-level 'minisite' setting and $this->getSettings()
    // to only provide the instance-level one, so we need to explicitly fetch
    // the field.
    $settings = $this
      ->getFieldDefinition()
      ->getFieldStorageDefinition()
      ->getSettings();
    $scheme_options = \Drupal::service('stream_wrapper_manager')
      ->getNames(StreamWrapperInterface::WRITE_VISIBLE);
    $element['uri_scheme'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Upload destination'),
      '#options' => $scheme_options,
      '#default_value' => $settings['uri_scheme'],
      '#description' => $this
        ->t('Select where the final files should be stored. Private file storage has significantly more overhead than public files, but allows restricted access to files within this field.'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {

    // Get base form from FileItem.
    $element = parent::fieldSettingsForm($form, $form_state);
    $settings = $this
      ->getSettings();
    $element['file_extensions']['#title'] = $this
      ->t('Allowed archive file extensions');
    if (!\Drupal::currentUser()
      ->hasPermission('administer site configuration')) {
      $element['file_extensions']['#disabled'] = TRUE;
    }

    // Make the extension list a little more human-friendly by comma-separation.
    $extensions = str_replace(' ', ', ', $settings['minisite_extensions']);
    $element['minisite_extensions'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Allowed file extensions in uploaded minisite files'),
      '#default_value' => $extensions,
      '#description' => $this
        ->t('Separate extensions with a space or comma and do not include the leading dot.'),
      '#element_validate' => [
        [
          get_class($this),
          'validateExtensions',
        ],
        [
          get_class($this),
          'validateNoDeniedExtensions',
        ],
      ],
      '#weight' => 11,
      '#maxlength' => 256,
      // By making this field required, we prevent a potential security issue
      // that would allow files of any type to be uploaded.
      '#required' => TRUE,
    ];
    return $element;
  }

  /**
   * Check that entered extensions are not in the denied extensions list.
   */
  public static function validateNoDeniedExtensions($element, FormStateInterface $form_state) {
    if (!empty($element['#value'])) {
      $extensions = preg_replace('/([, ]+\\.?)/', ' ', trim(strtolower($element['#value'])));
      $extensions = array_filter(explode(' ', $extensions));
      $denied_extensions = explode(' ', MinisiteInterface::DENIED_EXTENSIONS);
      $invalid_extensions = array_intersect($extensions, $denied_extensions);
      if (count($invalid_extensions) > 0) {
        $form_state
          ->setError($element, t('The list of allowed extensions is not valid, be sure to not include %ext extension(s).', [
          '%ext' => implode(', ', $invalid_extensions),
        ]));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postSave($update) {

    /** @var \Drupal\Core\Field\FieldItemList $item_list */
    $item_list = $this
      ->getParent();
    if (!$item_list
      ->isEmpty()) {
      $this
        ->createMinisite($item_list);
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function delete() {

    // This will fire once the parent entity is removed.

    /** @var \Drupal\Core\Field\FieldItemList $item_list */
    $item_list = $this
      ->getParent();
    if (!$item_list
      ->isEmpty()) {
      $this
        ->deleteMinisite($item_list);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function isDisplayed() {

    // Override parent class setting as Minisite items do not have per-item
    // visibility settings.
    return TRUE;
  }

  /**
   * Create Minisite instance from field values and save it.
   *
   * @param \Drupal\Core\Field\FieldItemList $item_list
   *   The item list.
   */
  protected function createMinisite(FieldItemList $item_list) {
    $minisite = Minisite::createInstance($item_list);
    if ($minisite) {
      $minisite
        ->save();

      // Set asset path from uploaded archive.
      $this->asset_path = $minisite
        ->getIndexAssetUri();
    }
  }

  /**
   * Delete Minisite instance created from field values.
   *
   * @param \Drupal\Core\Field\FieldItemList $item_list
   *   The item list.
   */
  protected function deleteMinisite(FieldItemList $item_list) {
    $minisite = Minisite::createInstance($item_list);
    if ($minisite) {
      $minisite
        ->delete();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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		1
DependencySerializationTrait::__wakeup	public	function		2
EntityReferenceItem::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemBase::calculateDependencies
EntityReferenceItem::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemBase::calculateStorageDependencies
EntityReferenceItem::fieldSettingsAjaxProcess	public static	function	Render API callback: Processes the field settings form and allows access to the form state.
EntityReferenceItem::fieldSettingsAjaxProcessElement	public static	function	Adds entity_reference specific properties to AJAX form elements from the field settings form.
EntityReferenceItem::fieldSettingsFormValidate	public static	function	Form element validation handler; Invokes selection plugin's validation.
EntityReferenceItem::formProcessMergeParent	public static	function	Render API callback: Moves entity_reference specific Form API elements (i.e. 'handler_settings') up a level for easier processing by the validation and submission handlers.
EntityReferenceItem::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedData::getConstraints
EntityReferenceItem::getPossibleOptions	public	function	Returns an array of possible values with labels for display. Overrides OptionsProviderInterface::getPossibleOptions
EntityReferenceItem::getPossibleValues	public	function	Returns an array of possible values. Overrides OptionsProviderInterface::getPossibleValues
EntityReferenceItem::getRandomBundle	protected static	function	Gets a bundle for a given entity type and selection options.
EntityReferenceItem::getSettableOptions	public	function	Returns an array of settable values with labels for display. Overrides OptionsProviderInterface::getSettableOptions
EntityReferenceItem::getSettableValues	public	function	Returns an array of settable values. Overrides OptionsProviderInterface::getSettableValues
EntityReferenceItem::getValue	public	function	Gets the data value. Overrides Map::getValue
EntityReferenceItem::hasNewEntity	public	function	Determines whether the item holds an unsaved entity.
EntityReferenceItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
EntityReferenceItem::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
EntityReferenceItem::onChange	public	function	React to changes to a child property or item. Overrides Map::onChange
EntityReferenceItem::onDependencyRemoval	public static	function	Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemBase::onDependencyRemoval
EntityReferenceItem::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemBase::preSave	1
EntityReferenceItem::settingsAjax	public static	function	Ajax callback for the handler settings form.
EntityReferenceItem::settingsAjaxSubmit	public static	function	Submit handler for the non-JS case.
EntityReferenceItem::setValue	public	function	Sets the data value. Overrides FieldItemBase::setValue
FieldItemBase::deleteRevision	public	function	Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData	1
FieldItemBase::fieldSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData	1
FieldItemBase::getEntity	public	function	Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition	public	function	Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode	public	function	Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting	protected	function	Returns the value of a field setting.
FieldItemBase::getSettings	protected	function	Returns the array of field settings.
FieldItemBase::storageSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData	2
FieldItemBase::storageSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData	2
FieldItemBase::view	public	function	Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue	protected	function	Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct	public	function	Constructs a TypedData object given its definition and context. Overrides TypedData::__construct	1
FieldItemBase::__get	public	function	Magic method: Gets a property value. Overrides FieldItemInterface::__get	2
FieldItemBase::__isset	public	function	Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set	public	function	Magic method: Sets a property value. Overrides FieldItemInterface::__set	1
FieldItemBase::__unset	public	function	Magic method: Unsets a property. Overrides FieldItemInterface::__unset
FileItem::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides EntityReferenceItem::defaultStorageSettings	1
FileItem::doGetUploadLocation	protected static	function	Determines the URI for a file field.
FileItem::generateSampleValue	public static	function	Generates placeholder field values. Overrides EntityReferenceItem::generateSampleValue	1
FileItem::getPreconfiguredOptions	public static	function	Returns preconfigured field options for a field type. Overrides EntityReferenceItem::getPreconfiguredOptions
FileItem::getUploadLocation	public	function	Determines the URI for a file field.
FileItem::getUploadValidators	public	function	Retrieves the upload validators for a file field.
FileItem::validateDirectory	public static	function	Form API callback
FileItem::validateExtensions	public static	function	Form API callback.
FileItem::validateMaxFilesize	public static	function	Form API callback.
Map::$definition	protected	property	The data definition. Overrides TypedData::$definition
Map::$properties	protected	property	The array of properties.
Map::$values	protected	property	An array of values for the contained properties.
Map::applyDefaultValue	public	function	Applies the default value. Overrides TypedData::applyDefaultValue	4
Map::get	public	function	Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator	public	function
Map::getProperties	public	function	Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString	public	function	Returns a string representation of the data. Overrides TypedData::getString
Map::set	public	function	Sets a property value. Overrides ComplexDataInterface::set
Map::toArray	public	function	Returns an array of all property values. Overrides ComplexDataInterface::toArray	1
Map::__clone	public	function	Magic method: Implements a deep clone.
MinisiteItem::createMinisite	protected	function	Create Minisite instance from field values and save it.
MinisiteItem::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FileItem::defaultFieldSettings
MinisiteItem::delete	public	function	Defines custom delete behavior for field values. Overrides FieldItemBase::delete
MinisiteItem::deleteMinisite	protected	function	Delete Minisite instance created from field values.
MinisiteItem::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FileItem::fieldSettingsForm
MinisiteItem::isDisplayed	public	function	Determines whether an item should be displayed when rendering the field. Overrides FileItem::isDisplayed
MinisiteItem::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemBase::postSave
MinisiteItem::propertyDefinitions	public static	function	Defines field item properties. Overrides FileItem::propertyDefinitions
MinisiteItem::schema	public static	function	Returns the schema for the field. Overrides FileItem::schema
MinisiteItem::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides FileItem::storageSettingsForm
MinisiteItem::validateNoDeniedExtensions	public static	function	Check that entered extensions are not in the denied extensions list.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class MinisiteItem in Mini site 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation