public static function IpRanges::baseFieldDefinitions in IP Ranges 8

Provides base field definitions for an entity type.

Implementations typically use the class \Drupal\Core\Field\BaseFieldDefinition for creating the field definitions; for example a 'name' field could be defined as the following:

$fields['name'] = BaseFieldDefinition::create('string')
  ->setLabel(t('Name'));

By definition, base fields are fields that exist for every bundle. To provide definitions for fields that should only exist on some bundles, use \Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions().

The definitions returned by this function can be overridden for all bundles by hook_entity_base_field_info_alter() or overridden on a per-bundle basis via 'base_field_override' configuration entities.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type definition. Useful when a single class is used for multiple, possibly dynamic entity types.

Return value

\Drupal\Core\Field\FieldDefinitionInterface[] An array of base field definitions for the entity type, keyed by field name.

Overrides ContentEntityBase::baseFieldDefinitions

File

lib/Drupal/ip_ranges/Entity/IpRanges.php, line 75

Class

IpRanges: Defines a Block configuration entity class.

Namespace

Drupal\ip_ranges\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['bid'] = FieldDefinition::create('integer')
    ->setLabel(t('User Restrictions ID'))
    ->setDescription(t('The User Restrictions ID.'))
    ->setReadOnly(TRUE);
  $fields['uuid'] = FieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The User Restrictions UUID.'))
    ->setReadOnly(TRUE);
  $fields['ip_lower'] = FieldDefinition::create('string')
    ->setLabel(t('IP'))
    ->setDescription(t('Text mask used for filtering restrictions.
      %: Matches any number of characters, even zero characters.
      _: Matches exactly one character.'))
    ->setRequired(TRUE)
    ->setSettings(array(
    'default_value' => '',
    'max_length' => 15,
  ));
  $fields['ip_higher'] = FieldDefinition::create('string')
    ->setLabel(t('IP'))
    ->setDescription(t('Text mask used for filtering restrictions.
      %: Matches any number of characters, even zero characters.
      _: Matches exactly one character.'))
    ->setSettings(array(
    'default_value' => '',
    'max_length' => 15,
  ));
  $fields['type'] = FieldDefinition::create('boolean')
    ->setLabel(t('Restriction status'))
    ->setDescription(t('A boolean indicating whether the ip range is whitelisted or blacklisted.'))
    ->setSetting('default_value', 1)
    ->setDisplayConfigurable('form', TRUE);
  $fields['description'] = FieldDefinition::create('string')
    ->setLabel(t('Range desctiption'))
    ->setDescription(t('Optional description for the IP Range.'))
    ->setSettings(array(
    'default_value' => '',
    'max_length' => 254,
  ));
  return $fields;
}

You are here