class LinkItem

Same name and namespace in other branches
  1. 8.9.x core/modules/link/src/Plugin/Field/FieldType/LinkItem.php \Drupal\link\Plugin\Field\FieldType\LinkItem
  2. 10 core/modules/link/src/Plugin/Field/FieldType/LinkItem.php \Drupal\link\Plugin\Field\FieldType\LinkItem
  3. 11.x core/modules/link/src/Plugin/Field/FieldType/LinkItem.php \Drupal\link\Plugin\Field\FieldType\LinkItem

Plugin implementation of the 'link' field type.

Plugin annotation

  id = "link",
  label = @Translation("Link"),
  description = @Translation("Stores a URL string, optional varchar link text, and optional blob of attributes to assemble a link."),
  default_widget = "link_default",
  default_formatter = "link",
  constraints = {"LinkType" = {}, "LinkAccess" = {}, "LinkExternalProtocols" = {}, "LinkNotExistingInternal" = {}}


Expanded class hierarchy of LinkItem


core/modules/link/src/Plugin/Field/FieldType/LinkItem.php, line 28


View source
class LinkItem extends FieldItemBase implements LinkItemInterface {
     * {@inheritdoc}
    public static function defaultFieldSettings() {
        return [
            'title' => DRUPAL_OPTIONAL,
            'link_type' => LinkItemInterface::LINK_GENERIC,
        ] + parent::defaultFieldSettings();
     * {@inheritdoc}
    public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
        $properties['uri'] = DataDefinition::create('uri')->setLabel(new TranslatableMarkup('URI'));
        $properties['title'] = DataDefinition::create('string')->setLabel(new TranslatableMarkup('Link text'));
        $properties['options'] = MapDataDefinition::create()->setLabel(new TranslatableMarkup('Options'));
        return $properties;
     * {@inheritdoc}
    public static function schema(FieldStorageDefinitionInterface $field_definition) {
        return [
            'columns' => [
                'uri' => [
                    'description' => 'The URI of the link.',
                    'type' => 'varchar',
                    'length' => 2048,
                'title' => [
                    'description' => 'The link text.',
                    'type' => 'varchar',
                    'length' => 255,
                'options' => [
                    'description' => 'Serialized array of options for the link.',
                    'type' => 'blob',
                    'size' => 'big',
                    'serialize' => TRUE,
            'indexes' => [
                'uri' => [
     * {@inheritdoc}
    public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
        $element = [];
        $element['link_type'] = [
            '#type' => 'radios',
            '#title' => $this->t('Allowed link type'),
            '#default_value' => $this->getSetting('link_type'),
            '#options' => [
                static::LINK_INTERNAL => $this->t('Internal links only'),
                static::LINK_EXTERNAL => $this->t('External links only'),
                static::LINK_GENERIC => $this->t('Both internal and external links'),
        $element['title'] = [
            '#type' => 'radios',
            '#title' => $this->t('Allow link text'),
            '#default_value' => $this->getSetting('title'),
            '#options' => [
                DRUPAL_DISABLED => $this->t('Disabled'),
                DRUPAL_OPTIONAL => $this->t('Optional'),
                DRUPAL_REQUIRED => $this->t('Required'),
        return $element;
     * {@inheritdoc}
    public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
        $random = new Random();
        if ($field_definition->getItemDefinition()
            ->getSetting('link_type') & LinkItemInterface::LINK_EXTERNAL) {
            // Set of possible top-level domains.
            $tlds = [
            // Set random length for the domain name.
            $domain_length = mt_rand(7, 15);
            switch ($field_definition->getSetting('title')) {
                case DRUPAL_DISABLED:
                    $values['title'] = '';
                case DRUPAL_REQUIRED:
                    $values['title'] = $random->sentences(4);
                case DRUPAL_OPTIONAL:
                    // In case of optional title, randomize its generation.
                    $values['title'] = mt_rand(0, 1) ? $random->sentences(4) : '';
            $values['uri'] = 'http://www.' . $random->word($domain_length) . '.' . $tlds[mt_rand(0, count($tlds) - 1)];
        else {
            $values['uri'] = 'base:' . $random->name(mt_rand(1, 64));
        return $values;
     * {@inheritdoc}
    public function isEmpty() {
        $value = $this->get('uri')
        return $value === NULL || $value === '';
     * {@inheritdoc}
    public function isExternal() {
        return $this->getUrl()
     * {@inheritdoc}
    public static function mainPropertyName() {
        return 'uri';
     * {@inheritdoc}
    public function getUrl() {
        return Url::fromUri($this->uri, (array) $this->options);
     * {@inheritdoc}
    public function setValue($values, $notify = TRUE) {
        // Treat the values as property value of the main property, if no array is
        // given.
        if (isset($values) && !is_array($values)) {
            $values = [
                static::mainPropertyName() => $values,
        if (isset($values)) {
            $values += [
                'options' => [],
        parent::setValue($values, $notify);



Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FieldItemBase::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies 1
FieldItemBase::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings 10
FieldItemBase::delete public function Defines custom delete behavior for field values. Overrides FieldItemInterface::delete 2
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::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval 1
FieldItemBase::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave 2
FieldItemBase::preSave public function Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave 7
FieldItemBase::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm 8
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
LinkItem::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
LinkItem::fieldSettingsForm public function Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm
LinkItem::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
LinkItem::getUrl public function Gets the URL object. Overrides LinkItemInterface::getUrl
LinkItem::isEmpty public function Determines whether the data structure is empty. Overrides Map::isEmpty
LinkItem::isExternal public function Determines if a link is external. Overrides LinkItemInterface::isExternal
LinkItem::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
LinkItem::propertyDefinitions public static function Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
LinkItem::schema public static function Returns the schema for the field. Overrides FieldItemInterface::schema
LinkItem::setValue public function Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides FieldItemBase::setValue
LinkItemInterface::LINK_EXTERNAL constant Specifies whether the field supports only external URLs.
LinkItemInterface::LINK_GENERIC constant Specifies whether the field supports both internal and external URLs.
LinkItemInterface::LINK_INTERNAL constant Specifies whether the field supports only internal URLs.
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::getValue public function Gets the data value. Overrides TypedData::getValue 1
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 4
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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::getConstraints public function Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints 9
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.