class DeveloperAttributesSettingsForm in Apigee Edge 8

Provides a form for changing the developer attribute related settings.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\apigee_edge\Form\DeveloperAttributesSettingsForm

Expanded class hierarchy of DeveloperAttributesSettingsForm

1 string reference to 'DeveloperAttributesSettingsForm'

apigee_edge.routing.yml in ./apigee_edge.routing.yml: apigee_edge.routing.yml

File

src/Form/DeveloperAttributesSettingsForm.php, line 36

Namespace

Drupal\apigee_edge\Form

View source

class DeveloperAttributesSettingsForm extends ConfigFormBase {

  /**
   * Field-attribute converter service.
   *
   * @var \Drupal\apigee_edge\FieldAttributeConverter
   */
  private $fieldAttributeConverter;

  /**
   * Entity field manager service.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  private $entityFieldManager;

  /**
   * Field storage formatter service.
   *
   * @var \Drupal\apigee_edge\Plugin\FieldStorageFormatManagerInterface
   */
  private $fieldStorageFormatManager;

  /**
   * DeveloperAttributesSettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   Entity field manager service.
   * @param \Drupal\apigee_edge\Plugin\FieldStorageFormatManagerInterface $field_storage_format_manager
   *   Field storage format manager service.
   * @param \Drupal\apigee_edge\FieldAttributeConverter $field_attribute_converter
   *   Field name to attribute name converted service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityFieldManagerInterface $entity_field_manager, FieldStorageFormatManagerInterface $field_storage_format_manager, FieldAttributeConverter $field_attribute_converter) {
    parent::__construct($config_factory);
    $this->fieldAttributeConverter = $field_attribute_converter;
    $this->entityFieldManager = $entity_field_manager;
    $this->fieldStorageFormatManager = $field_storage_format_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('entity_field.manager'), $container
      ->get('plugin.manager.apigee_field_storage_format'), $container
      ->get('apigee_edge.converter.field_attribute'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'apigee_edge_developer_attributes_settings_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'apigee_edge.sync',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('apigee_edge.sync');
    $form['#attached']['library'][] = 'apigee_edge/apigee_edge.admin';
    $form['developer_attributes'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Developer attributes'),
      '#open' => TRUE,
    ];
    $form['developer_attributes']['instructions'] = [
      '#markup' => $this
        ->t('Select the <a href=":url_manage">user fields</a> that have to be synced to the Apigee Edge server.<br>You can also add a <a href=":url_new">new field</a> to users.', [
        ':url_manage' => Url::fromRoute('entity.user.field_ui_fields')
          ->toString(),
        ':url_new' => Url::fromRoute('field_ui.field_storage_config_add_user')
          ->toString(),
      ]),
    ];
    $fields = array_filter($this->entityFieldManager
      ->getFieldDefinitions('user', 'user'), function ($field_definition) {
      return $field_definition instanceof FieldConfigInterface;
    });
    uasort($fields, [
      FieldConfig::class,
      'sort',
    ]);
    $options = $default_values = [];

    /** @var \Drupal\field\FieldConfigInterface $field */
    foreach ($fields as $field) {
      $options[$field
        ->getName()] = [
        'field_label' => $field
          ->getLabel(),
        'field_name' => $field
          ->getName(),
        'field_type' => $field
          ->getType(),
        'attribute_name' => $this->fieldAttributeConverter
          ->getAttributeName($field
          ->getName()),
      ];
      $formatter = $this->fieldStorageFormatManager
        ->lookupPluginForFieldType($field
        ->getType());
      if (isset($formatter)) {
        $rc = new \ReflectionClass($this->fieldStorageFormatManager
          ->lookupPluginForFieldType($field
          ->getType()));
        $short_name = $rc
          ->getShortName();
        $options[$field
          ->getName()]['field_storage_formatter'] = $short_name;
      }
      else {
        $options[$field
          ->getName()]['field_storage_formatter'] = $this
          ->t('- None -');
      }
      if (in_array($field
        ->getName(), $config
        ->get('user_fields_to_sync'))) {
        $default_values[$field
          ->getName()] = TRUE;
      }
    }
    $form['developer_attributes']['attributes'] = [
      '#type' => 'tableselect',
      '#header' => [
        'field_label' => $this
          ->t('User field label'),
        'field_name' => $this
          ->t('User field name'),
        'field_type' => $this
          ->t('User field type'),
        'field_storage_formatter' => $this
          ->t('Storage formatter'),
        'attribute_name' => $this
          ->t('Developer attribute name'),
      ],
      '#options' => $options,
      '#default_value' => $default_values,
      '#empty' => $this
        ->t('No user fields found.'),
      '#attributes' => [
        'class' => [
          'table--developer-attributes',
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('apigee_edge.sync')
      ->set('user_fields_to_sync', array_values(array_filter($form_state
      ->getValue('attributes'))))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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
DeveloperAttributesSettingsForm::$entityFieldManager	private	property	Entity field manager service.
DeveloperAttributesSettingsForm::$fieldAttributeConverter	private	property	Field-attribute converter service.
DeveloperAttributesSettingsForm::$fieldStorageFormatManager	private	property	Field storage formatter service.
DeveloperAttributesSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
DeveloperAttributesSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
DeveloperAttributesSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
DeveloperAttributesSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DeveloperAttributesSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
DeveloperAttributesSettingsForm::__construct	public	function	DeveloperAttributesSettingsForm constructor. Overrides ConfigFormBase::__construct
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class DeveloperAttributesSettingsForm in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation