You are here

Home » API reference » CRM Core 8 » RuleForm.php

class RuleForm in CRM Core 8

Same name and namespace in other branches
  1. 8.3 modules/crm_core_user_sync/src/Form/RuleForm.php \Drupal\crm_core_user_sync\Form\RuleForm

Configure CRM Core User Synchronization settings for this site.

Hierarchy

Expanded class hierarchy of RuleForm

1 string reference to 'RuleForm'
crm_core_user_sync.routing.yml in modules/crm_core_user_sync/crm_core_user_sync.routing.yml
modules/crm_core_user_sync/crm_core_user_sync.routing.yml

File

modules/crm_core_user_sync/src/Form/RuleForm.php, line 12

Namespace

Drupal\crm_core_user_sync\Form
View source 
class RuleForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $rule_key = 'new') {
    $config = $this
      ->config('crm_core_user_sync.settings');
    $rules = $config
      ->get('rules');
    if ($rule_key === 'new') {
      $rule = [
        'role' => '',
        'contact_type' => '',
        'enabled' => TRUE,
        'weight' => 0,
      ];
      $form_state
        ->set('rule_key', 'new');
    }
    else {
      if (isset($rules[$rule_key])) {
        $rule = $rules[$rule_key];
        $form_state
          ->set('rule', $rule);
        $form_state
          ->set('rule_key', $rule_key);
      }
      else {
        $rule = [
          'role' => '',
          'contact_type' => '',
          'enabled' => TRUE,
          'weight' => 0,
        ];
        $form_state
          ->set('rule_key', 'new');
      }
    }
    $types_options = [
      '' => $this
        ->t('- Select -'),
    ];
    foreach (IndividualType::loadMultiple() as $type) {
      $types_options[$type
        ->id()] = $type
        ->label();
    }
    $role_options = [
      '' => $this
        ->t('- Select -'),
    ];
    foreach (user_roles(TRUE) as $role) {
      $role_options[$role
        ->id()] = $role
        ->label();
    }
    $form['role'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('User Role'),
      '#options' => $role_options,
      '#default_value' => isset($rule['role']) ? $rule['role'] : '',
      '#required' => TRUE,
    ];
    $form['contact_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Contact Type'),
      '#options' => $types_options,
      '#default_value' => isset($rule['contact_type']) ? $rule['contact_type'] : '',
      '#required' => TRUE,
    ];
    $form['weight'] = [
      '#type' => 'weight',
      '#title' => $this
        ->t('Weight'),
      '#default_value' => isset($rule['weight']) ? $rule['weight'] : 0,
    ];
    $form['enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enabled'),
      '#default_value' => isset($rule['enabled']) ? $rule['enabled'] : TRUE,
      '#description' => $this
        ->t('When checked, this rule will be used to synchronize user accounts. When unchecked, it will be ignored throughout the system.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $rule = $form_state
      ->get('rule');
    foreach ([
      'role',
      'contact_type',
      'weight',
      'enabled',
    ] as $key) {
      $rule[$key] = $form_state
        ->getValue($key);
    }
    $rules = $this
      ->config('crm_core_user_sync.settings')
      ->get('rules');
    $rule_key = $form_state
      ->get('rule_key');
    if ($rule_key === 'new') {
      $rules[] = $rule;
    }
    else {
      $rules[$rule_key] = $rule;
    }
    $this
      ->config('crm_core_user_sync.settings')
      ->set('rules', $rules)
      ->save();
    $form_state
      ->setRedirect('crm_core_user_sync.config');
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
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
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.
RuleForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
RuleForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RuleForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RuleForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
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.