class Contact in FZ152 8

Provides an annotated Fz152 plugin to configure contact form.

Plugin annotation

@Fz152(
  id = "contact",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\fz152\Fz152PluginBase implements Fz152PluginInterface
      • class \Drupal\fz152_contact\Plugin\Fz152\Contact

1 string reference to 'Contact'

Contact::getSettingsPage in modules/contact/src/Plugin/Fz152/Contact.php

If you want to add settings as tab to main settings you can define it here.

File

modules/contact/src/Plugin/Fz152/Contact.php, line 15

Namespace

Drupal\fz152_contact\Plugin\Fz152

class Contact extends Fz152PluginBase {

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

  /**
   * {@inheritdoc}
   */
  public function getSettingsPage() {
    return [
      'path' => 'contact',
      'title' => 'Contact',
      'form' => Fz152ContactSettings::class,
      'weight' => 5,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getForms() {
    $forms = [];
    $contact_forms = $this
      ->getContactForms();
    foreach (array_keys($contact_forms) as $form) {
      $config = $this
        ->config("fz152_contact.settings.{$form}");
      if ($config
        ->get('enabled')) {
        $forms[] = [
          'form_id' => 'contact_message_' . $form . '_form',
          'weight' => $config
            ->get('weight') ?: NULL,
        ];
      }
    }
    return $forms;
  }

  /**
   * Returns a list of contact forms.
   *
   * @return array
   *   A keyed array of contact forms.
   *
   * @see \Drupal\Core\Entity\EntityTypeBundleInfoInterface::getBundleInfo()
   */
  protected function getContactForms() {

    /** @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundleInfo */
    $bundleInfo = \Drupal::service('entity_type.bundle.info');
    return $bundleInfo
      ->getBundleInfo('contact_message');
  }

  /**
   * Retrieves a configuration object.
   *
   * @param string $name
   *   The config name to retrieve.
   *
   * @return \Drupal\Core\Config\ImmutableConfig
   *   The config object.
   */
  protected function config($name) {
    if (!isset($this->configFactory)) {
      $this->configFactory = \Drupal::service('config.factory');
    }
    return $this->configFactory
      ->get($name);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Contact::$configFactory	protected	property	The config factory.
Contact::config	protected	function	Retrieves a configuration object.
Contact::getContactForms	protected	function	Returns a list of contact forms.
Contact::getForms	public	function	Returns a list of form to and confirmation for sending private data. Overrides Fz152PluginBase::getForms
Contact::getSettingsPage	public	function	If you want to add settings as tab to main settings you can define it here. Overrides Fz152PluginBase::getSettingsPage
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		1
DependencySerializationTrait::__wakeup	public	function		2
Fz152PluginBase::getId	public	function	Overrides Fz152PluginInterface::getId
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.