class LingotekIntelligenceServiceConfig in Lingotek Translation 3.6.x

Service for managing Lingotek Intelligence related configuration.

@package Drupal\lingotek

Hierarchy

• class \Drupal\lingotek\LingotekIntelligenceServiceConfig implements ContainerInjectionInterface, LingotekIntelligenceMetadataInterface

1 file declares its use of LingotekIntelligenceServiceConfig

LingotekIntelligenceMetadataForm.php in src/Form/LingotekIntelligenceMetadataForm.php

1 string reference to 'LingotekIntelligenceServiceConfig'

lingotek.services.yml in ./lingotek.services.yml

lingotek.services.yml

1 service uses LingotekIntelligenceServiceConfig

lingotek.intelligence_config in ./lingotek.services.yml

Drupal\lingotek\LingotekIntelligenceServiceConfig

File

src/LingotekIntelligenceServiceConfig.php, line 14

Namespace

Drupal\lingotek

class LingotekIntelligenceServiceConfig implements LingotekIntelligenceMetadataInterface, ContainerInjectionInterface {

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a LingotekIntelligenceService object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function setBusinessUnit($business_unit) {
    return $this
      ->setValue('business_unit', $business_unit);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setBusinessDivision($business_division) {
    return $this
      ->setValue('business_division', $business_division);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setCampaignId($campaign_id) {
    return $this
      ->setValue('campaign_id', $campaign_id);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setCampaignRating($campaign_rating) {
    return $this
      ->setValue('campaign_rating', $campaign_rating);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setChannel($channel) {
    return $this
      ->setValue('channel', $channel);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setContactName($contact_name) {
    return $this
      ->setValue('contact_name', $contact_name);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setContactEmail($contact_email) {
    return $this
      ->setValue('contact_email', $contact_email);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setContentDescription($content_description) {
    return $this
      ->setValue('content_description', $content_description);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setPurchaseOrder($purchase_order) {
    return $this
      ->setValue('purchase_order', $purchase_order);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setExternalStyleId($external_style_id) {
    return $this
      ->setValue('external_style_id', $external_style_id);
  }

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

  /**
   * {@inheritdoc}
   */
  public function setRegion($region) {
    return $this
      ->setValue('region', $region);
  }

  /**
   * {@inheritdoc}
   */
  public function getAuthorPermission() {
    $value = NULL;
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_author');
  }

  /**
   * {@inheritdoc}
   */
  public function setAuthorPermission($use_author) {
    return $this
      ->setValue('use_author', $use_author);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultAuthorEmail() {
    $value = NULL;
    $config = $this->configFactory
      ->get('lingotek.settings');
    if ($config
      ->get('intelligence.use_author_email')) {
      $value = $config
        ->get('intelligence.default_author_email');
    }
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function setDefaultAuthorEmail($default_author_email) {
    return $this
      ->setValue('default_author_email', $default_author_email);
  }

  /**
   * {@inheritdoc}
   */
  public function getAuthorEmailPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_author_email');
  }

  /**
   * {@inheritdoc}
   */
  public function setAuthorEmailPermission($use_author_email) {
    return $this
      ->setValue('use_author_email', $use_author_email);
  }

  /**
   * {@inheritdoc}
   */
  public function getContactEmailForAuthorPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_contact_email_for_author');
  }

  /**
   * {@inheritdoc}
   */
  public function setContactEmailForAuthorPermission($use_contact_email_for_author) {
    return $this
      ->setValue('use_contact_email_for_author', $use_contact_email_for_author);
  }

  /**
   * {@inheritdoc}
   */
  public function getBusinessUnitPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_business_unit');
  }

  /**
   * {@inheritdoc}
   */
  public function setBusinessUnitPermission($use_business_unit) {
    return $this
      ->setValue('use_business_unit', $use_business_unit);
  }

  /**
   * {@inheritdoc}
   */
  public function getBusinessDivisionPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_business_division');
  }

  /**
   * {@inheritdoc}
   */
  public function setBusinessDivisionPermission($use_business_division) {
    return $this
      ->setValue('use_business_division', $use_business_division);
  }

  /**
   * {@inheritdoc}
   */
  public function getCampaignIdPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_campaign_id');
  }

  /**
   * {@inheritdoc}
   */
  public function setCampaignIdPermission($use_campaign_id) {
    return $this
      ->setValue('use_campaign_id', $use_campaign_id);
  }

  /**
   * {@inheritdoc}
   */
  public function getCampaignRatingPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_campaign_rating');
  }

  /**
   * {@inheritdoc}
   */
  public function setCampaignRatingPermission($use_campaign_rating) {
    return $this
      ->setValue('use_campaign_rating', $use_campaign_rating);
  }

  /**
   * {@inheritdoc}
   */
  public function getChannelPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_channel');
  }

  /**
   * {@inheritdoc}
   */
  public function setChannelPermission($use_channel) {
    return $this
      ->setValue('use_channel', $use_channel);
  }

  /**
   * {@inheritdoc}
   */
  public function getContactNamePermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_contact_name');
  }

  /**
   * {@inheritdoc}
   */
  public function setContactNamePermission($use_contact_name) {
    return $this
      ->setValue('use_contact_name', $use_contact_name);
  }

  /**
   * {@inheritdoc}
   */
  public function getContactEmailPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_contact_email');
  }

  /**
   * {@inheritdoc}
   */
  public function setContactEmailPermission($use_contact_email) {
    return $this
      ->setValue('use_contact_email', $use_contact_email);
  }

  /**
   * {@inheritdoc}
   */
  public function getContentDescriptionPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_content_description');
  }

  /**
   * {@inheritdoc}
   */
  public function setContentDescriptionPermission($use_content_description) {
    return $this
      ->setValue('use_content_description', $use_content_description);
  }

  /**
   * {@inheritdoc}
   */
  public function getExternalStyleIdPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_external_style_id');
  }

  /**
   * {@inheritdoc}
   */
  public function setExternalStyleIdPermission($use_external_style_id) {
    return $this
      ->setValue('use_external_style_id', $use_external_style_id);
  }

  /**
   * {@inheritdoc}
   */
  public function getPurchaseOrderPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_purchase_order');
  }

  /**
   * {@inheritdoc}
   */
  public function setPurchaseOrderPermission($use_purchase_order) {
    return $this
      ->setValue('use_purchase_order', $use_purchase_order);
  }

  /**
   * {@inheritdoc}
   */
  public function getRegionPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_region');
  }

  /**
   * {@inheritdoc}
   */
  public function setRegionPermission($use_region) {
    return $this
      ->setValue('use_region', $use_region);
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseDomainPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_base_domain');
  }

  /**
   * {@inheritdoc}
   */
  public function setBaseDomainPermission($use_base_domain) {
    return $this
      ->setValue('use_base_domain', $use_base_domain);
  }

  /**
   * {@inheritdoc}
   */
  public function getReferenceUrlPermission() {
    $config = $this->configFactory
      ->get('lingotek.settings');
    return $config
      ->get('intelligence.use_reference_url');
  }

  /**
   * {@inheritdoc}
   */
  public function setReferenceUrlPermission($use_reference_url) {
    return $this
      ->setValue('use_reference_url', $use_reference_url);
  }

  /**
   * Helper for getting a value from config, validating that the usage is set.
   *
   * @param string $key
   *   The key.
   *
   * @return array|mixed|null
   */
  protected function getValue($key) {
    $value = NULL;
    $config = $this->configFactory
      ->get('lingotek.settings');
    if ($config
      ->get('intelligence.use_' . $key)) {
      $value = $config
        ->get('intelligence.' . $key);
    }
    return $value;
  }

  /**
   * Helper for setting a value to config.
   *
   * @param string $key
   *   The key.
   * @param $value
   *   The value.
   *
   * @return $this
   */
  protected function setValue($key, $value) {
    $config = $this->configFactory
      ->getEditable('lingotek.settings');
    $config
      ->set('intelligence.' . $key, $value);
    $config
      ->save();
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LingotekIntelligenceServiceConfig::$configFactory	protected	property	The configuration factory.
LingotekIntelligenceServiceConfig::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
LingotekIntelligenceServiceConfig::getAuthorEmailPermission	public	function	Gets the Permission setting for whether or not the Author Email should be sent. Overrides LingotekIntelligenceMetadataInterface::getAuthorEmailPermission
LingotekIntelligenceServiceConfig::getAuthorPermission	public	function	Gets the Permission setting for Author Permission. Overrides LingotekIntelligenceMetadataInterface::getAuthorPermission
LingotekIntelligenceServiceConfig::getBaseDomainPermission	public	function	Gets the Permission setting for whether or not to include the Base Domain in the metadata. Overrides LingotekIntelligenceMetadataInterface::getBaseDomainPermission
LingotekIntelligenceServiceConfig::getBusinessDivision	public	function	Gets the Business Division associated with this content. Overrides LingotekIntelligenceMetadataInterface::getBusinessDivision
LingotekIntelligenceServiceConfig::getBusinessDivisionPermission	public	function	Gets the Permission setting for whether or not to use the Business Division. Overrides LingotekIntelligenceMetadataInterface::getBusinessDivisionPermission
LingotekIntelligenceServiceConfig::getBusinessUnit	public	function	Gets the Business Unit associated with this content. Overrides LingotekIntelligenceMetadataInterface::getBusinessUnit
LingotekIntelligenceServiceConfig::getBusinessUnitPermission	public	function	Gets the Permission setting for wheter or not to use the Business Unit. Overrides LingotekIntelligenceMetadataInterface::getBusinessUnitPermission
LingotekIntelligenceServiceConfig::getCampaignId	public	function	Get the Campaign ID associated with this content. Overrides LingotekIntelligenceMetadataInterface::getCampaignId
LingotekIntelligenceServiceConfig::getCampaignIdPermission	public	function	Gets the Permission setting for whether or not to use the Campaign Id. Overrides LingotekIntelligenceMetadataInterface::getCampaignIdPermission
LingotekIntelligenceServiceConfig::getCampaignRating	public	function	Get the Campaign Rating associated with the content and the Campaign (which is represented by the Campaign ID). Overrides LingotekIntelligenceMetadataInterface::getCampaignRating
LingotekIntelligenceServiceConfig::getCampaignRatingPermission	public	function	Gets the Permission setting for whether or not the Campaign Rating should be used and tracked. Overrides LingotekIntelligenceMetadataInterface::getCampaignRatingPermission
LingotekIntelligenceServiceConfig::getChannel	public	function	Gets the Channel associated with the content. Overrides LingotekIntelligenceMetadataInterface::getChannel
LingotekIntelligenceServiceConfig::getChannelPermission	public	function	Gets the Permission setting for whether or not the Channel should be used and tracked. Overrides LingotekIntelligenceMetadataInterface::getChannelPermission
LingotekIntelligenceServiceConfig::getContactEmail	public	function	Gets the Contact Email for the Contact Person responsible for this content. Overrides LingotekIntelligenceMetadataInterface::getContactEmail
LingotekIntelligenceServiceConfig::getContactEmailForAuthorPermission	public	function	Gets the Permission setting for whether or not to use the Contact Email as the author's email. Overrides LingotekIntelligenceMetadataInterface::getContactEmailForAuthorPermission
LingotekIntelligenceServiceConfig::getContactEmailPermission	public	function	Gets the Permission setting for whether or not to include the Contact Email. Overrides LingotekIntelligenceMetadataInterface::getContactEmailPermission
LingotekIntelligenceServiceConfig::getContactName	public	function	Gets the name of the contact responsible for this content. Overrides LingotekIntelligenceMetadataInterface::getContactName
LingotekIntelligenceServiceConfig::getContactNamePermission	public	function	Gets the Permission setting for whether or not to include the Contact Name. Overrides LingotekIntelligenceMetadataInterface::getContactNamePermission
LingotekIntelligenceServiceConfig::getContentDescription	public	function	Gets the description of this content. Overrides LingotekIntelligenceMetadataInterface::getContentDescription
LingotekIntelligenceServiceConfig::getContentDescriptionPermission	public	function	Gets the Permission setting for whether or not to include the Content Description. Overrides LingotekIntelligenceMetadataInterface::getContentDescriptionPermission
LingotekIntelligenceServiceConfig::getDefaultAuthorEmail	public	function	Gets the Default Author Email. Overrides LingotekIntelligenceMetadataInterface::getDefaultAuthorEmail
LingotekIntelligenceServiceConfig::getExternalStyleId	public	function	Gets the External Style ID associated with this content. Overrides LingotekIntelligenceMetadataInterface::getExternalStyleId
LingotekIntelligenceServiceConfig::getExternalStyleIdPermission	public	function	Gets the Permission setting for whether or not to include the External Style Id. Overrides LingotekIntelligenceMetadataInterface::getExternalStyleIdPermission
LingotekIntelligenceServiceConfig::getPurchaseOrder	public	function	Gets the Purchase Order. Overrides LingotekIntelligenceMetadataInterface::getPurchaseOrder
LingotekIntelligenceServiceConfig::getPurchaseOrderPermission	public	function	Gets the Permission setting for whether or not to include the Purchase Order. Overrides LingotekIntelligenceMetadataInterface::getPurchaseOrderPermission
LingotekIntelligenceServiceConfig::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
LingotekIntelligenceServiceConfig::getRegion	public	function	Gets the Region the content is presented to. Overrides LingotekIntelligenceMetadataInterface::getRegion
LingotekIntelligenceServiceConfig::getRegionPermission	public	function	Gets the Permission setting for whether or not to include the Region. Overrides LingotekIntelligenceMetadataInterface::getRegionPermission
LingotekIntelligenceServiceConfig::getValue	protected	function	Helper for getting a value from config, validating that the usage is set.
LingotekIntelligenceServiceConfig::setAuthorEmailPermission	public	function	Sets the Permission setting for whether or not an Author Email should be used in the Intelligence Metadata. Overrides LingotekIntelligenceMetadataInterface::setAuthorEmailPermission
LingotekIntelligenceServiceConfig::setAuthorPermission	public	function	Sets the Permission setting for whether or not the author information should be sent. Overrides LingotekIntelligenceMetadataInterface::setAuthorPermission
LingotekIntelligenceServiceConfig::setBaseDomainPermission	public	function	Sets the Permission setting for whether or not to include the Base Domain in the metadata. Overrides LingotekIntelligenceMetadataInterface::setBaseDomainPermission
LingotekIntelligenceServiceConfig::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
LingotekIntelligenceServiceConfig::setBusinessDivisionPermission	public	function	Sets the Permission setting for whether or not to use the Business Division. Overrides LingotekIntelligenceMetadataInterface::setBusinessDivisionPermission
LingotekIntelligenceServiceConfig::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
LingotekIntelligenceServiceConfig::setBusinessUnitPermission	public	function	Sets the Permission setting for whether or not to use the Business Unit. Overrides LingotekIntelligenceMetadataInterface::setBusinessUnitPermission
LingotekIntelligenceServiceConfig::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
LingotekIntelligenceServiceConfig::setCampaignIdPermission	public	function	Sets the Permission setting for whether or not to use the Campaign Id. Overrides LingotekIntelligenceMetadataInterface::setCampaignIdPermission
LingotekIntelligenceServiceConfig::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
LingotekIntelligenceServiceConfig::setCampaignRatingPermission	public	function	Sets the Permission setting for whether or not the Campaign Rating should be used and tracked. Overrides LingotekIntelligenceMetadataInterface::setCampaignRatingPermission
LingotekIntelligenceServiceConfig::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
LingotekIntelligenceServiceConfig::setChannelPermission	public	function	Sets the Permission setting for whether or not the Channel should be used and tracked. Overrides LingotekIntelligenceMetadataInterface::setChannelPermission
LingotekIntelligenceServiceConfig::setContactEmail	public	function	Sets the Contact Email for the Contact Person responsible for this content. Overrides LingotekIntelligenceMetadataInterface::setContactEmail
LingotekIntelligenceServiceConfig::setContactEmailForAuthorPermission	public	function	Sets the Permission setting for whether or not to use the Contact Email as the author's email. Overrides LingotekIntelligenceMetadataInterface::setContactEmailForAuthorPermission
LingotekIntelligenceServiceConfig::setContactEmailPermission	public	function	Sets the Permission setting for whether or not to include the Contact Email. Overrides LingotekIntelligenceMetadataInterface::setContactEmailPermission
LingotekIntelligenceServiceConfig::setContactName	public	function	Sets the name of the person to contact in regards to this content. Overrides LingotekIntelligenceMetadataInterface::setContactName
LingotekIntelligenceServiceConfig::setContactNamePermission	public	function	Sets the Permission setting for whether or not to include the Contact Name. Overrides LingotekIntelligenceMetadataInterface::setContactNamePermission
LingotekIntelligenceServiceConfig::setContentDescription	public	function	Sets the description for this content. Overrides LingotekIntelligenceMetadataInterface::setContentDescription
LingotekIntelligenceServiceConfig::setContentDescriptionPermission	public	function	Sets the Permission setting for whether or not to include the Content Description. Overrides LingotekIntelligenceMetadataInterface::setContentDescriptionPermission
LingotekIntelligenceServiceConfig::setDefaultAuthorEmail	public	function	Sets the Default Author Email that should be used. Overrides LingotekIntelligenceMetadataInterface::setDefaultAuthorEmail
LingotekIntelligenceServiceConfig::setExternalStyleId	public	function	Sets the External Style ID that is associated with the marketing and style the content is using. Overrides LingotekIntelligenceMetadataInterface::setExternalStyleId
LingotekIntelligenceServiceConfig::setExternalStyleIdPermission	public	function	Sets the Permission setting for whether or not to include the External Style Id. Overrides LingotekIntelligenceMetadataInterface::setExternalStyleIdPermission
LingotekIntelligenceServiceConfig::setPurchaseOrder	public	function	Sets the Purchase Order associated with the purchase of the translation. Overrides LingotekIntelligenceMetadataInterface::setPurchaseOrder
LingotekIntelligenceServiceConfig::setPurchaseOrderPermission	public	function	Sets the Permission setting for whether or not to include the Purchase Order. Overrides LingotekIntelligenceMetadataInterface::setPurchaseOrderPermission
LingotekIntelligenceServiceConfig::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
LingotekIntelligenceServiceConfig::setRegion	public	function	Sets the Region the content is meant for, presented to, or created in. Overrides LingotekIntelligenceMetadataInterface::setRegion
LingotekIntelligenceServiceConfig::setRegionPermission	public	function	Sets the Permission setting for whether or not to include the Region. Overrides LingotekIntelligenceMetadataInterface::setRegionPermission
LingotekIntelligenceServiceConfig::setValue	protected	function	Helper for setting a value to config.
LingotekIntelligenceServiceConfig::__construct	public	function	Constructs a LingotekIntelligenceService object.