You are here

Home » API reference » Profile 8 » ProfileType.php

class ProfileType in Profile 8

Defines the profile type entity class.

Plugin annotation


@ConfigEntityType(
  id = "profile_type",
  label = @Translation("Profile type"),
  label_collection = @Translation("Profile types"),
  label_singular = @Translation("profile type"),
  label_plural = @Translation("profile types"),
  label_count = @PluralTranslation(
    singular = "@count profile type",
    plural = "@count profile types",
  ),
  handlers = {
    "list_builder" = "Drupal\profile\ProfileTypeListBuilder",
    "form" = {
      "default" = "Drupal\profile\Form\ProfileTypeForm",
      "add" = "Drupal\profile\Form\ProfileTypeForm",
      "edit" = "Drupal\profile\Form\ProfileTypeForm",
      "duplicate" = "Drupal\profile\Form\ProfileTypeForm",
      "delete" = "Drupal\profile\Form\ProfileTypeDeleteForm"
    },
    "local_task_provider" = {
      "default" = "Drupal\entity\Menu\DefaultEntityLocalTaskProvider",
    },
    "route_provider" = {
      "html" = "Drupal\entity\Routing\DefaultHtmlRouteProvider",
    },
  },
  admin_permission = "administer profile types",
  config_prefix = "type",
  bundle_of = "profile",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "display_label",
    "multiple",
    "registration",
    "roles",
    "allow_revisions",
    "new_revision",
  },
  links = {
    "add-form" = "/admin/config/people/profile-types/add",
    "edit-form" = "/admin/config/people/profile-types/manage/{profile_type}",
    "duplicate-form" = "/admin/config/people/profile-types/manage/{profile_type}/duplicate",
    "delete-form" = "/admin/config/people/profile-types/manage/{profile_type}/delete",
    "collection" = "/admin/config/people/profile-types"
  }
)

Hierarchy

Expanded class hierarchy of ProfileType

11 files declare their use of ProfileType
profile.module in ./profile.module
Support for configurable user profiles.
profile.post_update.php in ./profile.post_update.php
Post update functions for Profile.
profile.tokens.inc in ./profile.tokens.inc
Provides token support for profiles.
ProfileAccessControlHandler.php in src/ProfileAccessControlHandler.php
ProfileRevisionTest.php in tests/src/Functional/ProfileRevisionTest.php

... See full list

File

src/Entity/ProfileType.php, line 64

Namespace

Drupal\profile\Entity
View source 
class ProfileType extends ConfigEntityBundleBase implements ProfileTypeInterface {

  /**
   * The profile type ID.
   *
   * @var int
   */
  protected $id;

  /**
   * The profile type label.
   *
   * @var string
   */
  protected $label;

  /**
   * The profile type display label.
   *
   * @var string
   */
  protected $display_label;

  /**
   * Whether a user can have multiple profiles of this type.
   *
   * @var bool
   */
  protected $multiple = FALSE;

  /**
   * Whether a profile of this type should be created during registration.
   *
   * @var bool
   */
  protected $registration = FALSE;

  /**
   * The user roles allowed to have profiles of this type.
   *
   * @var array
   */
  protected $roles = [];

  /**
   * Whether profiles of this type allow revisions.
   *
   * @var bool
   */
  protected $allow_revisions = FALSE;

  /**
   * Should profiles of this type always generate revisions.
   *
   * @var bool
   */
  protected $new_revision = FALSE;

  /**
   * {@inheritdoc}
   */
  public function getDisplayLabel() {
    return $this->display_label;
  }

  /**
   * {@inheritdoc}
   */
  public function setDisplayLabel($display_label) {
    $this->display_label = $display_label;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function allowsMultiple() {
    return $this->multiple;
  }

  /**
   * {@inheritdoc}
   */
  public function setMultiple($multiple) {
    $this->multiple = $multiple;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getRegistration() {
    return $this->registration;
  }

  /**
   * {@inheritdoc}
   */
  public function setRegistration($registration) {
    $this->registration = $registration;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getRoles() {
    return $this->roles;
  }

  /**
   * {@inheritdoc}
   */
  public function setRoles(array $roles) {
    $this->roles = $roles;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function allowsRevisions() {
    return $this->allow_revisions;
  }

  /**
   * {@inheritdoc}
   */
  public function shouldCreateNewRevision() {
    return $this
      ->allowsRevisions() && $this->new_revision;
  }

  /**
   * {@inheritdoc}
   */
  public function showRevisionUi() {
    return $this
      ->allowsRevisions() && $this
      ->entityTypeManager()
      ->getDefinition('profile')
      ->showRevisionUi();
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    if ($this
      ->shouldCreateNewRevision() && !$this
      ->allowsRevisions()) {
      $this
        ->set('new_revision', FALSE);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);

    // Rebuild the user page tab.
    \Drupal::service('router.builder')
      ->setRebuildNeeded();

    // Update the "register" form display, if needed.
    $original_registration = isset($this->original) ? $this->original
      ->getRegistration() : FALSE;
    $registration = $this
      ->getRegistration();
    if ($original_registration != $registration) {
      $register_display = EntityFormDisplay::load('user.user.register');
      if (!$register_display) {

        // The "register" form mode isn't customized by default.
        $default_display = EntityFormDisplay::load('user.user.default');
        if (!$default_display) {

          // @todo Remove once we require Drupal 8.8. See #2835616.
          $default_display = EntityFormDisplay::create([
            'targetEntityType' => 'user',
            'bundle' => 'user',
            'mode' => 'default',
            'status' => TRUE,
          ]);
        }
        $register_display = $default_display
          ->createCopy('register');
      }
      if ($registration) {
        $register_display
          ->setComponent($this
          ->id() . '_profiles', [
          'type' => 'profile_form',
          'weight' => 90,
        ]);
      }
      else {
        $register_display
          ->removeComponent($this
          ->id() . '_profiles');
      }
      $register_display
        ->setStatus(TRUE);
      $register_display
        ->save();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete 2
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 Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
ProfileType::$allow_revisions protected property Whether profiles of this type allow revisions.
ProfileType::$display_label protected property The profile type display label.
ProfileType::$id protected property The profile type ID.
ProfileType::$label protected property The profile type label.
ProfileType::$multiple protected property Whether a user can have multiple profiles of this type.
ProfileType::$new_revision protected property Should profiles of this type always generate revisions.
ProfileType::$registration protected property Whether a profile of this type should be created during registration.
ProfileType::$roles protected property The user roles allowed to have profiles of this type.
ProfileType::allowsMultiple public function Gets whether a user can have multiple profiles of this type. Overrides ProfileTypeInterface::allowsMultiple
ProfileType::allowsRevisions public function Gets whether this profile type allows revisions. Overrides ProfileTypeInterface::allowsRevisions
ProfileType::getDisplayLabel public function Gets the profile type display label. Overrides ProfileTypeInterface::getDisplayLabel
ProfileType::getRegistration public function Gets whether a profile of this type should be created during registration. Overrides ProfileTypeInterface::getRegistration
ProfileType::getRoles public function Gets the user roles allowed to have profiles of this type. Overrides ProfileTypeInterface::getRoles
ProfileType::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
ProfileType::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBundleBase::preSave
ProfileType::setDisplayLabel public function Sets the profile type display label. Overrides ProfileTypeInterface::setDisplayLabel
ProfileType::setMultiple public function Sets whether a user can have multiple profiles of this type. Overrides ProfileTypeInterface::setMultiple
ProfileType::setRegistration public function Sets whether a profile of this type should be created during registration. Overrides ProfileTypeInterface::setRegistration
ProfileType::setRoles public function Sets the user roles allowed to have profiles of this type. Overrides ProfileTypeInterface::setRoles
ProfileType::shouldCreateNewRevision public function Gets whether a new revision should be created by default. Overrides RevisionableEntityBundleInterface::shouldCreateNewRevision
ProfileType::showRevisionUi public function Gets whether profiles of this type should show the revision fields. Overrides ProfileTypeInterface::showRevisionUi
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function