You are here

Home » API reference » Lingotek Translation 8.2 » LingotekProfile.php

class LingotekProfile in Lingotek Translation 8.2

Same name and namespace in other branches
  1. 8 src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  2. 4.0.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  3. 3.0.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  4. 3.1.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  5. 3.2.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  6. 3.3.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  7. 3.4.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  8. 3.5.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  9. 3.6.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  10. 3.7.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile
  11. 3.8.x src/Entity/LingotekProfile.php \Drupal\lingotek\Entity\LingotekProfile

Defines the LingotekProfile entity.

Plugin annotation


@ConfigEntityType(
  id = "lingotek_profile",
  label = @Translation("Lingotek Profile"),
  handlers = {
    "list_builder" = "Drupal\lingotek\LingotekProfileListBuilder",
    "form" = {
      "add" = "Drupal\lingotek\Form\LingotekProfileAddForm",
      "edit" = "Drupal\lingotek\Form\LingotekProfileEditForm",
      "delete" = "Drupal\lingotek\Form\LingotekProfileDeleteForm"
    },
  },
  admin_permission = "administer lingotek",
  config_prefix = "profile",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "weight" = "weight"
  },
  config_export = {
    "id",
    "label",
    "weight",
    "locked",
    "auto_upload",
    "auto_request",
    "auto_download",
    "auto_download_worker",
    "append_type_to_title",
    "vault",
    "project",
    "workflow",
    "intelligence_metadata",
    "filter",
    "subfilter",
    "language_overrides",
  },
  links = {
    "add-form" = "/admin/lingotek/settings/profile/add",
    "delete-form" = "/admin/lingotek/settings/profile/{profile}/delete",
    "edit-form" = "/admin/lingotek/settings/profile/{profile}/edit",
  },
)

Hierarchy

Expanded class hierarchy of LingotekProfile

19 files declare their use of LingotekProfile
lingotek.install in ./lingotek.install
Install, update and uninstall functions for the Lingotek module.
lingotek.module in ./lingotek.module
Implements Drupal-related hooks for the Lingotek Translation module.
LingotekBatchController.php in src/Controller/LingotekBatchController.php
LingotekConfigurationService.php in src/LingotekConfigurationService.php
LingotekContentEntityGetProfileHookTest.php in tests/src/Functional/LingotekContentEntityGetProfileHookTest.php

... See full list

File

src/Entity/LingotekProfile.php, line 55

Namespace

Drupal\lingotek\Entity
View source 
class LingotekProfile extends ConfigEntityBase implements LingotekProfileInterface, LingotekIntelligenceMetadataInterface {

  /**
   * The profile ID (machine name).
   *
   * @var string
   */
  protected $id;

  /**
   * The human-readable label for the profile.
   *
   * @var string
   */
  protected $label;

  /**
   * The weight of the profile, used in lists of profiles.
   *
   * @var integer
   */
  protected $weight = 0;

  /**
   * Locked profiles cannot be edited.
   *
   * @var bool
   */
  protected $locked = FALSE;

  /**
   * Entities using this profile may automatically upload sources.
   *
   * @var bool
   */
  protected $auto_upload = FALSE;

  /**
   * Entities using this profile may automatically request translations.
   *
   * @var bool
   */
  protected $auto_request = FALSE;

  /**
   * Entities using this profile may automatically download translations.
   *
   * @var bool
   */
  protected $auto_download = FALSE;

  /**
   * Entities using this profile may use a worker queue to download translations.
   *
   * @var bool
   */
  protected $auto_download_worker = FALSE;

  /**
   * Entities using this profile will use this vault.
   *
   * @var string
   */
  protected $vault = 'default';

  /**
   * Entities using this profile will use this FPRM Filter.
   *
   * @var string
   */
  protected $filter = 'drupal_default';

  /**
   * Entities using this profile will use this FPRM Subfilter.
   *
   * @var string
   */
  protected $subfilter = 'drupal_default';

  /**
   * Entities using this profile will use this project.
   *
   * @var string
   */
  protected $project = 'default';

  /**
   * Entities using this profile will use this workflow.
   *
   * @var string
   */
  protected $workflow = 'default';

  /**
   * Specific target language settings override.
   *
   * @var string
   */
  protected $language_overrides = [];

  /**
   * If content type is to be appended to title when uploading to TMS.
   *
   * @var string
   */
  protected $append_type_to_title = 'global_setting';

  /**
   * Metadata for content with this translation profile
   *
   * @var array
   */
  protected $intelligence_metadata = [
    'override' => FALSE,
    'business_unit' => '',
    'business_division' => '',
    'campaign_id' => '',
    'campaign_rating' => 0,
    'channel' => '',
    'contact_name' => '',
    'contact_email' => '',
    'content_description' => '',
    'external_style_id' => '',
    'purchase_order' => '',
    'region' => '',
    'use_author' => TRUE,
    'default_author_email' => '',
    'use_author_email' => TRUE,
    'use_contact_email_for_author' => FALSE,
    'use_business_unit' => TRUE,
    'use_business_division' => TRUE,
    'use_campaign_id' => TRUE,
    'use_campaign_rating' => TRUE,
    'use_channel' => TRUE,
    'use_contact_name' => TRUE,
    'use_contact_email' => TRUE,
    'use_content_description' => TRUE,
    'use_external_style_id' => TRUE,
    'use_purchase_order' => TRUE,
    'use_region' => TRUE,
    'use_base_domain' => TRUE,
    'use_reference_url' => TRUE,
  ];

  /**
   * {@inheritdoc}
   */
  public function __construct(array $values, $entity_type) {
    if (isset($values['intelligence_metadata']) && is_array($values['intelligence_metadata'])) {
      $values['intelligence_metadata'] += $this->intelligence_metadata;
    }
    return parent::__construct($values, $entity_type);
  }

  /**
   * {@inheritdoc}
   */
  public function getBusinessUnit() {
    return $this->intelligence_metadata['business_unit'];
  }

  /**
   * {@inheritdoc}
   */
  public function setBusinessUnit($business_unit) {
    $this->intelligence_metadata['business_unit'] = $business_unit;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBusinessDivision() {
    return $this->intelligence_metadata['business_division'];
  }

  /**
   * {@inheritdoc}
   */
  public function setBusinessDivision($business_division) {
    $this->intelligence_metadata['business_division'] = $business_division;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCampaignId() {
    return $this->intelligence_metadata['campaign_id'];
  }

  /**
   * {@inheritdoc}
   */
  public function setCampaignId($campaign_id) {
    $this->intelligence_metadata['campaign_id'] = $campaign_id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCampaignRating() {
    return $this->intelligence_metadata['campaign_rating'];
  }

  /**
   * {@inheritdoc}
   */
  public function setCampaignRating($campaign_rating) {
    $this->intelligence_metadata['campaign_rating'] = $campaign_rating;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getChannel() {
    return $this->intelligence_metadata['channel'];
  }

  /**
   * {@inheritdoc}
   */
  public function setChannel($channel) {
    $this->intelligence_metadata['channel'] = $channel;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getContactName() {
    return $this->intelligence_metadata['contact_name'];
  }

  /**
   * {@inheritdoc}
   */
  public function setContactName($contact_name) {
    $this->intelligence_metadata['contact_name'] = $contact_name;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getContactEmail() {
    return $this->intelligence_metadata['contact_email'];
  }

  /**
   * {@inheritdoc}
   */
  public function setContactEmail($contact_email) {
    $this->intelligence_metadata['contact_email'] = $contact_email;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getContentDescription() {
    return $this->intelligence_metadata['content_description'];
  }

  /**
   * {@inheritdoc}
   */
  public function setContentDescription($content_description) {
    $this->intelligence_metadata['content_description'] = $content_description;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPurchaseOrder() {
    return $this->intelligence_metadata['purchase_order'];
  }

  /**
   * {@inheritdoc}
   */
  public function setPurchaseOrder($purchase_order) {
    $this->intelligence_metadata['purchase_order'] = $purchase_order;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getExternalStyleId() {
    return $this->intelligence_metadata['external_style_id'];
  }

  /**
   * {@inheritdoc}
   */
  public function setExternalStyleId($external_style_id) {
    $this->intelligence_metadata['external_style_id'] = $external_style_id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getRegion() {
    return $this->intelligence_metadata['region'];
  }

  /**
   * {@inheritdoc}
   */
  public function setRegion($region) {
    $this->intelligence_metadata['region'] = $region;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getAuthorPermission() {
    return $this->intelligence_metadata['use_author'];
  }

  /**
   * {@inheritdoc}
   */
  public function setAuthorPermission($use_author) {
    $this->intelligence_metadata['use_author'] = $use_author;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultAuthorEmail() {
    return $this->intelligence_metadata['default_author_email'];
  }

  /**
   * {@inheritdoc}
   */
  public function setDefaultAuthorEmail($default_author_email) {
    $this->intelligence_metadata['default_author_email'] = $default_author_email;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getAuthorEmailPermission() {
    return $this->intelligence_metadata['use_author_email'];
  }

  /**
   * {@inheritdoc}
   */
  public function setAuthorEmailPermission($use_author_email) {
    $this->intelligence_metadata['use_author_email'] = $use_author_email;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getContactEmailForAuthorPermission() {
    return $this->intelligence_metadata['use_contact_email_for_author'];
  }

  /**
   * {@inheritdoc}
   */
  public function setContactEmailForAuthorPermission($use_contact_email_for_author) {
    $this->intelligence_metadata['use_contact_email_for_author'] = $use_contact_email_for_author;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBusinessUnitPermission() {
    return $this->intelligence_metadata['use_business_unit'];
  }

  /**
   * {@inheritdoc}
   */
  public function setBusinessUnitPermission($use_business_unit) {
    $this->intelligence_metadata['use_business_unit'] = $use_business_unit;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBusinessDivisionPermission() {
    return $this->intelligence_metadata['use_business_division'];
  }

  /**
   * {@inheritdoc}
   */
  public function setBusinessDivisionPermission($use_business_division) {
    $this->intelligence_metadata['use_business_division'] = $use_business_division;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCampaignIdPermission() {
    return $this->intelligence_metadata['use_campaign_id'];
  }

  /**
   * {@inheritdoc}
   */
  public function setCampaignIdPermission($use_campaign_id) {
    $this->intelligence_metadata['use_campaign_id'] = $use_campaign_id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getCampaignRatingPermission() {
    return $this->intelligence_metadata['use_campaign_rating'];
  }

  /**
   * {@inheritdoc}
   */
  public function setCampaignRatingPermission($use_campaign_rating) {
    $this->intelligence_metadata['use_campaign_rating'] = $use_campaign_rating;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getChannelPermission() {
    return $this->intelligence_metadata['use_channel'];
  }

  /**
   * {@inheritdoc}
   */
  public function setChannelPermission($use_channel) {
    $this->intelligence_metadata['use_channel'] = $use_channel;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getContactNamePermission() {
    return $this->intelligence_metadata['use_contact_name'];
  }

  /**
   * {@inheritdoc}
   */
  public function setContactNamePermission($use_contact_name) {
    $this->intelligence_metadata['use_contact_name'] = $use_contact_name;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getContactEmailPermission() {
    return $this->intelligence_metadata['use_contact_email'];
  }

  /**
   * {@inheritdoc}
   */
  public function setContactEmailPermission($use_contact_email) {
    $this->intelligence_metadata['use_contact_email'] = $use_contact_email;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getContentDescriptionPermission() {
    return $this->intelligence_metadata['use_content_description'];
  }

  /**
   * {@inheritdoc}
   */
  public function setContentDescriptionPermission($use_content_description) {
    $this->intelligence_metadata['use_content_description'] = $use_content_description;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getExternalStyleIdPermission() {
    return $this->intelligence_metadata['use_external_style_id'];
  }

  /**
   * {@inheritdoc}
   */
  public function setExternalStyleIdPermission($use_external_style_id) {
    $this->intelligence_metadata['use_external_style_id'] = $use_external_style_id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPurchaseOrderPermission() {
    return $this->intelligence_metadata['use_purchase_order'];
  }

  /**
   * {@inheritdoc}
   */
  public function setPurchaseOrderPermission($use_purchase_order) {
    $this->intelligence_metadata['use_purchase_order'] = $use_purchase_order;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getRegionPermission() {
    return $this->intelligence_metadata['use_region'];
  }

  /**
   * {@inheritdoc}
   */
  public function setRegionPermission($use_region) {
    $this->intelligence_metadata['use_region'] = $use_region;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseDomainPermission() {
    return $this->intelligence_metadata['use_base_domain'];
  }

  /**
   * {@inheritdoc}
   */
  public function setBaseDomainPermission($use_base_domain) {
    $this->intelligence_metadata['use_base_domain'] = $use_base_domain;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getReferenceUrlPermission() {
    return $this->intelligence_metadata['use_reference_url'];
  }

  /**
   * {@inheritdoc}
   */
  public function setReferenceUrlPermission($use_reference_url) {
    $this->intelligence_metadata['use_reference_url'] = $use_reference_url;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isLocked() {
    return (bool) $this->locked;
  }

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

  /**
   * {@inheritdoc}
   */
  public function setAppendContentTypeToTitle($append_type_to_title = 'global_setting') {
    $this->append_type_to_title = $append_type_to_title;
    return $this;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function hasAutomaticUpload() {
    return (bool) $this->auto_upload;
  }

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

  /**
   * {@inheritdoc}
   */
  public function hasAutomaticDownloadWorker() {
    return (bool) $this->auto_download_worker;
  }

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

  /**
   * {@inheritdoc}
   */
  public function hasAutomaticRequest() {
    return (bool) $this->auto_request;
  }

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

  /**
   * {@inheritdoc}
   */
  public function hasAutomaticDownload() {
    return (bool) $this->auto_download;
  }

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

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function setSubfilter($filter) {
    $this->subfilter = $filter;
    return $this;
  }

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

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

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

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

  // ToDo: Avoid deletion if this profile is being used.

  /**
   * {@inheritdoc}
   */
  public function getWorkflowForTarget($langcode) {
    $workflow = $this
      ->getWorkflow();
    if (isset($this->language_overrides[$langcode]) && $this
      ->hasCustomSettingsForTarget($langcode)) {
      $workflow = $this->language_overrides[$langcode]['custom']['workflow'];
    }
    return $workflow;
  }

  /**
   * {@inheritdoc}
   */
  public function setWorkflowForTarget($langcode, $value) {
    $this->language_overrides[$langcode]['custom']['workflow'] = $value;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasAutomaticRequestForTarget($langcode) {
    $auto_request = $this
      ->hasAutomaticRequest();
    if (isset($this->language_overrides[$langcode]) && $this
      ->hasCustomSettingsForTarget($langcode)) {
      $auto_request = $this->language_overrides[$langcode]['custom']['auto_request'];
    }
    return $auto_request;
  }

  /**
   * {@inheritdoc}
   */
  public function setAutomaticRequestForTarget($langcode, $value) {
    $this->language_overrides[$langcode]['custom']['auto_request'] = $value;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasAutomaticDownloadForTarget($langcode) {
    $auto_download = $this
      ->hasAutomaticDownload();
    if (isset($this->language_overrides[$langcode]) && $this
      ->hasCustomSettingsForTarget($langcode)) {
      $auto_download = $this->language_overrides[$langcode]['custom']['auto_download'];
    }
    return $auto_download;
  }

  /**
   * {@inheritdoc}
   */
  public function setAutomaticDownloadForTarget($langcode, $value) {
    $this->language_overrides[$langcode]['custom']['auto_download'] = $value;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasCustomSettingsForTarget($langcode) {
    return isset($this->language_overrides[$langcode]) && $this->language_overrides[$langcode]['overrides'] === 'custom';
  }

  /**
   * {@inheritdoc}
   */
  public function hasIntelligenceMetadataOverrides() {
    return isset($this->intelligence_metadata['override']) && $this->intelligence_metadata['override'] === TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function setIntelligenceMetadataOverrides($value) {
    $this->intelligence_metadata['override'] = $value;
    return $this;
  }

}

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::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
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::__sleep public function Overrides EntityBase::__sleep 4
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::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
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.
LingotekProfile::$append_type_to_title protected property If content type is to be appended to title when uploading to TMS.
LingotekProfile::$auto_download protected property Entities using this profile may automatically download translations.
LingotekProfile::$auto_download_worker protected property Entities using this profile may use a worker queue to download translations.
LingotekProfile::$auto_request protected property Entities using this profile may automatically request translations.
LingotekProfile::$auto_upload protected property Entities using this profile may automatically upload sources.
LingotekProfile::$filter protected property Entities using this profile will use this FPRM Filter.
LingotekProfile::$id protected property The profile ID (machine name).
LingotekProfile::$intelligence_metadata protected property Metadata for content with this translation profile
LingotekProfile::$label protected property The human-readable label for the profile.
LingotekProfile::$language_overrides protected property Specific target language settings override.
LingotekProfile::$locked protected property Locked profiles cannot be edited.
LingotekProfile::$project protected property Entities using this profile will use this project.
LingotekProfile::$subfilter protected property Entities using this profile will use this FPRM Subfilter.
LingotekProfile::$vault protected property Entities using this profile will use this vault.
LingotekProfile::$weight protected property The weight of the profile, used in lists of profiles.
LingotekProfile::$workflow protected property Entities using this profile will use this workflow.
LingotekProfile::getAppendContentTypeToTitle public function Returns value of append content type to title option. Overrides LingotekProfileInterface::getAppendContentTypeToTitle
LingotekProfile::getAuthorEmailPermission public function Gets the Permission setting for whether or not the Author Email should be sent. Overrides LingotekIntelligenceMetadataInterface::getAuthorEmailPermission
LingotekProfile::getAuthorPermission public function Gets the Permission setting for Author Permission. Overrides LingotekIntelligenceMetadataInterface::getAuthorPermission
LingotekProfile::getBaseDomainPermission public function Gets the Permission setting for whether or not to include the Base Domain in the metadata. Overrides LingotekIntelligenceMetadataInterface::getBaseDomainPermission
LingotekProfile::getBusinessDivision public function Gets the Business Division associated with this content. Overrides LingotekIntelligenceMetadataInterface::getBusinessDivision
LingotekProfile::getBusinessDivisionPermission public function Gets the Permission setting for whether or not to use the Business Division. Overrides LingotekIntelligenceMetadataInterface::getBusinessDivisionPermission
LingotekProfile::getBusinessUnit public function Gets the Business Unit associated with this content. Overrides LingotekIntelligenceMetadataInterface::getBusinessUnit
LingotekProfile::getBusinessUnitPermission public function Gets the Permission setting for wheter or not to use the Business Unit. Overrides LingotekIntelligenceMetadataInterface::getBusinessUnitPermission
LingotekProfile::getCampaignId public function Get the Campaign ID associated with this content. Overrides LingotekIntelligenceMetadataInterface::getCampaignId
LingotekProfile::getCampaignIdPermission public function Gets the Permission setting for whether or not to use the Campaign Id. Overrides LingotekIntelligenceMetadataInterface::getCampaignIdPermission
LingotekProfile::getCampaignRating public function Get the Campaign Rating associated with the content and the Campaign (which is represented by the Campaign ID). Overrides LingotekIntelligenceMetadataInterface::getCampaignRating
LingotekProfile::getCampaignRatingPermission public function Gets the Permission setting for whether or not the Campaign Rating should be used and tracked. Overrides LingotekIntelligenceMetadataInterface::getCampaignRatingPermission
LingotekProfile::getChannel public function Gets the Channel associated with the content. Overrides LingotekIntelligenceMetadataInterface::getChannel
LingotekProfile::getChannelPermission public function Gets the Permission setting for whether or not the Channel should be used and tracked. Overrides LingotekIntelligenceMetadataInterface::getChannelPermission
LingotekProfile::getContactEmail public function Gets the Contact Email for the Contact Person responsible for this content. Overrides LingotekIntelligenceMetadataInterface::getContactEmail
LingotekProfile::getContactEmailForAuthorPermission public function Gets the Permission setting for whether or not to use the Contact Email as the author's email. Overrides LingotekIntelligenceMetadataInterface::getContactEmailForAuthorPermission
LingotekProfile::getContactEmailPermission public function Gets the Permission setting for whether or not to include the Contact Email. Overrides LingotekIntelligenceMetadataInterface::getContactEmailPermission
LingotekProfile::getContactName public function Gets the name of the contact responsible for this content. Overrides LingotekIntelligenceMetadataInterface::getContactName
LingotekProfile::getContactNamePermission public function Gets the Permission setting for whether or not to include the Contact Name. Overrides LingotekIntelligenceMetadataInterface::getContactNamePermission
LingotekProfile::getContentDescription public function Gets the description of this content. Overrides LingotekIntelligenceMetadataInterface::getContentDescription
LingotekProfile::getContentDescriptionPermission public function Gets the Permission setting for whether or not to include the Content Description. Overrides LingotekIntelligenceMetadataInterface::getContentDescriptionPermission
LingotekProfile::getDefaultAuthorEmail public function Gets the Default Author Email. Overrides LingotekIntelligenceMetadataInterface::getDefaultAuthorEmail
LingotekProfile::getExternalStyleId public function Gets the External Style ID associated with this content. Overrides LingotekIntelligenceMetadataInterface::getExternalStyleId
LingotekProfile::getExternalStyleIdPermission public function Gets the Permission setting for whether or not to include the External Style Id. Overrides LingotekIntelligenceMetadataInterface::getExternalStyleIdPermission
LingotekProfile::getFilter public function Gets the FPRM filter of the profile. Overrides LingotekFilterProviderInterface::getFilter
LingotekProfile::getProject public function Gets the TM project of the profile. Overrides LingotekProfileInterface::getProject
LingotekProfile::getPurchaseOrder public function Gets the Purchase Order. Overrides LingotekIntelligenceMetadataInterface::getPurchaseOrder
LingotekProfile::getPurchaseOrderPermission public function Gets the Permission setting for whether or not to include the Purchase Order. Overrides LingotekIntelligenceMetadataInterface::getPurchaseOrderPermission
LingotekProfile::getReferenceUrlPermission public function Gets the Permission setting for whether or not the Reference URL for this content should be included in the metadata. Overrides LingotekIntelligenceMetadataInterface::getReferenceUrlPermission
LingotekProfile::getRegion public function Gets the Region the content is presented to. Overrides LingotekIntelligenceMetadataInterface::getRegion
LingotekProfile::getRegionPermission public function Gets the Permission setting for whether or not to include the Region. Overrides LingotekIntelligenceMetadataInterface::getRegionPermission
LingotekProfile::getSubfilter public function Gets the FPRM subfilter of the profile. Overrides LingotekFilterProviderInterface::getSubfilter
LingotekProfile::getVault public function Gets the TM vault of the profile. Overrides LingotekProfileInterface::getVault
LingotekProfile::getWeight public function Gets the weight of the profile. Overrides LingotekProfileInterface::getWeight
LingotekProfile::getWorkflow public function Gets the workflow of the profile. Overrides LingotekProfileInterface::getWorkflow
LingotekProfile::getWorkflowForTarget public function Gets the workflow to be used for a given language. Overrides LingotekProfileInterface::getWorkflowForTarget
LingotekProfile::hasAutomaticDownload public function Returns whether this profile indicates automatic download of translations. Overrides LingotekProfileInterface::hasAutomaticDownload
LingotekProfile::hasAutomaticDownloadForTarget public function Returns whether this profile indicates automatic download of translations for an specific target language. Overrides LingotekProfileInterface::hasAutomaticDownloadForTarget
LingotekProfile::hasAutomaticDownloadWorker public function Returns whether this profile indicates automatically adding downloads to a worker queue. Overrides LingotekProfileInterface::hasAutomaticDownloadWorker
LingotekProfile::hasAutomaticRequest public function Returns whether this profile indicates automatic request of translations. Overrides LingotekProfileInterface::hasAutomaticRequest
LingotekProfile::hasAutomaticRequestForTarget public function Returns whether this profile indicates automatic request of translations for an specific target language. Overrides LingotekProfileInterface::hasAutomaticRequestForTarget
LingotekProfile::hasAutomaticUpload public function Returns whether this profile indicates automatic upload of sources. Overrides LingotekProfileInterface::hasAutomaticUpload
LingotekProfile::hasCustomSettingsForTarget public function Checks if the profile has custom settings for a given target language. Overrides LingotekProfileInterface::hasCustomSettingsForTarget
LingotekProfile::hasIntelligenceMetadataOverrides public function Checks if the profile overrides settings for Intelligence metadata. Overrides LingotekProfileInterface::hasIntelligenceMetadataOverrides
LingotekProfile::isLocked public function Returns whether this profile is locked. Overrides LingotekProfileInterface::isLocked
LingotekProfile::setAppendContentTypeToTitle public function Sets the value of append content type to title option. Overrides LingotekProfileInterface::setAppendContentTypeToTitle
LingotekProfile::setAuthorEmailPermission public function Sets the Permission setting for whether or not an Author Email should be used in the Intelligence Metadata. Overrides LingotekIntelligenceMetadataInterface::setAuthorEmailPermission
LingotekProfile::setAuthorPermission public function Sets the Permission setting for whether or not the author information should be sent. Overrides LingotekIntelligenceMetadataInterface::setAuthorPermission
LingotekProfile::setAutomaticDownload public function Sets whether this profile indicates automatic download of translations. Overrides LingotekProfileInterface::setAutomaticDownload
LingotekProfile::setAutomaticDownloadForTarget public function Sets whether this profile indicates automatic download of translations for an specific target language. Overrides LingotekProfileInterface::setAutomaticDownloadForTarget
LingotekProfile::setAutomaticDownloadWorker public function Sets whether this profile indicates automatically adding downloads to a worker queue. Overrides LingotekProfileInterface::setAutomaticDownloadWorker
LingotekProfile::setAutomaticRequest public function Sets whether this profile indicates automatic request of translations. Overrides LingotekProfileInterface::setAutomaticRequest
LingotekProfile::setAutomaticRequestForTarget public function Sets whether this profile indicates automatic request of translations for an specific target language. Overrides LingotekProfileInterface::setAutomaticRequestForTarget
LingotekProfile::setAutomaticUpload public function Sets whether this profile indicates automatic upload of sources. Overrides LingotekProfileInterface::setAutomaticUpload
LingotekProfile::setBaseDomainPermission public function Sets the Permission setting for whether or not to include the Base Domain in the metadata. Overrides LingotekIntelligenceMetadataInterface::setBaseDomainPermission
LingotekProfile::setBusinessDivision public function Set the Business Division responsible for the content with this metadata. A Business Division is defined as a discrete part of a company that may operate under the same name and legal responsibility or as a separate corporate and legal entity under… Overrides LingotekIntelligenceMetadataInterface::setBusinessDivision
LingotekProfile::setBusinessDivisionPermission public function Sets the Permission setting for whether or not to use the Business Division. Overrides LingotekIntelligenceMetadataInterface::setBusinessDivisionPermission
LingotekProfile::setBusinessUnit public function Sets the Business Unit responsible for the content with this metadata. A business unit is a relatively autonomous division of a large company that operates as an independent enterprise with responsibility for a particular range of products or activities. Overrides LingotekIntelligenceMetadataInterface::setBusinessUnit
LingotekProfile::setBusinessUnitPermission public function Sets the Permission setting for whether or not to use the Business Unit. Overrides LingotekIntelligenceMetadataInterface::setBusinessUnitPermission
LingotekProfile::setCampaignId public function Set the Campaign ID associated with this content. The Campaign ID could be for a marketing or other campaign. This allows particular content to be associated with the campaign and then be able to see how a campaign is doing by only looking at content… Overrides LingotekIntelligenceMetadataInterface::setCampaignId
LingotekProfile::setCampaignIdPermission public function Sets the Permission setting for whether or not to use the Campaign Id. Overrides LingotekIntelligenceMetadataInterface::setCampaignIdPermission
LingotekProfile::setCampaignRating public function Sets the Campaign Rating. The Campaign rating must be numeric, but can otherwise be used to rate the campaign and its effect on this content. Overrides LingotekIntelligenceMetadataInterface::setCampaignRating
LingotekProfile::setCampaignRatingPermission public function Sets the Permission setting for whether or not the Campaign Rating should be used and tracked. Overrides LingotekIntelligenceMetadataInterface::setCampaignRatingPermission
LingotekProfile::setChannel public function Sets the Channel associated with the content. A channel is a way or outlet to market and sell products. This can be used to associate the content with a particular marketing channel. Overrides LingotekIntelligenceMetadataInterface::setChannel
LingotekProfile::setChannelPermission public function Sets the Permission setting for whether or not the Channel should be used and tracked. Overrides LingotekIntelligenceMetadataInterface::setChannelPermission
LingotekProfile::setContactEmail public function Sets the Contact Email for the Contact Person responsible for this content. Overrides LingotekIntelligenceMetadataInterface::setContactEmail
LingotekProfile::setContactEmailForAuthorPermission public function Sets the Permission setting for whether or not to use the Contact Email as the author's email. Overrides LingotekIntelligenceMetadataInterface::setContactEmailForAuthorPermission
LingotekProfile::setContactEmailPermission public function Sets the Permission setting for whether or not to include the Contact Email. Overrides LingotekIntelligenceMetadataInterface::setContactEmailPermission
LingotekProfile::setContactName public function Sets the name of the person to contact in regards to this content. Overrides LingotekIntelligenceMetadataInterface::setContactName
LingotekProfile::setContactNamePermission public function Sets the Permission setting for whether or not to include the Contact Name. Overrides LingotekIntelligenceMetadataInterface::setContactNamePermission
LingotekProfile::setContentDescription public function Sets the description for this content. Overrides LingotekIntelligenceMetadataInterface::setContentDescription
LingotekProfile::setContentDescriptionPermission public function Sets the Permission setting for whether or not to include the Content Description. Overrides LingotekIntelligenceMetadataInterface::setContentDescriptionPermission
LingotekProfile::setDefaultAuthorEmail public function Sets the Default Author Email that should be used. Overrides LingotekIntelligenceMetadataInterface::setDefaultAuthorEmail
LingotekProfile::setExternalStyleId public function Sets the External Style ID that is associated with the marketing and style the content is using. Overrides LingotekIntelligenceMetadataInterface::setExternalStyleId
LingotekProfile::setExternalStyleIdPermission public function Sets the Permission setting for whether or not to include the External Style Id. Overrides LingotekIntelligenceMetadataInterface::setExternalStyleIdPermission
LingotekProfile::setFilter public function Sets the FPRM filter of the profile. Overrides LingotekFilterProviderInterface::setFilter
LingotekProfile::setIntelligenceMetadataOverrides public function Set if the profile overrides settings for Intelligence metadata. Overrides LingotekProfileInterface::setIntelligenceMetadataOverrides
LingotekProfile::setProject public function Sets the TM vault of the profile. Overrides LingotekProfileInterface::setProject
LingotekProfile::setPurchaseOrder public function Sets the Purchase Order associated with the purchase of the translation. Overrides LingotekIntelligenceMetadataInterface::setPurchaseOrder
LingotekProfile::setPurchaseOrderPermission public function Sets the Permission setting for whether or not to include the Purchase Order. Overrides LingotekIntelligenceMetadataInterface::setPurchaseOrderPermission
LingotekProfile::setReferenceUrlPermission public function Sets the Permission setting for whether or not the Reference URL for this content should be included in the metadata. Overrides LingotekIntelligenceMetadataInterface::setReferenceUrlPermission
LingotekProfile::setRegion public function Sets the Region the content is meant for, presented to, or created in. Overrides LingotekIntelligenceMetadataInterface::setRegion
LingotekProfile::setRegionPermission public function Sets the Permission setting for whether or not to include the Region. Overrides LingotekIntelligenceMetadataInterface::setRegionPermission
LingotekProfile::setSubfilter public function Sets the FPRM subfilter of the profile. Overrides LingotekFilterProviderInterface::setSubfilter
LingotekProfile::setVault public function Sets the TM vault of the profile. Overrides LingotekProfileInterface::setVault
LingotekProfile::setWeight public function Sets the weight of the profile. Overrides LingotekProfileInterface::setWeight
LingotekProfile::setWorkflow public function Sets the workflow of the profile. Overrides LingotekProfileInterface::setWorkflow
LingotekProfile::setWorkflowForTarget public function Sets the workflow to be used for a given language. Overrides LingotekProfileInterface::setWorkflowForTarget
LingotekProfile::__construct public function Constructs an Entity object. Overrides ConfigEntityBase::__construct
LingotekProfileInterface::USED_BY_SETTINGS constant The profile is being used in config.
LingotekProfileInterface::USED_IN_CONFIG constant The profile is being used in config.
LingotekProfileInterface::USED_IN_CONTENT constant The profile is being used in content.
LingotekProfileInterface::USED_NEVER constant The profile is not being used.
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
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