OrganizationTypeForm.php in CRM Core 8.3

Namespace

Drupal\crm_core_contact\Form

File

modules/crm_core_contact/src/Form/OrganizationTypeForm.php

<?php

namespace Drupal\crm_core_contact\Form;

use Drupal\Core\Entity\BundleEntityFormBase;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Form\FormStateInterface;

/**
 * Class OrganizationTypeForm.
 *
 * Provides a form for the OrganizationType entity.
 *
 * @package Drupal\crm_core_contact\Form
 */
class OrganizationTypeForm extends BundleEntityFormBase {

  /**
   * Default primary fields.
   *
   * TODO: Add option back to alter primary fields.
   *
   * @var array
   */
  protected $defaultPrimaryFields = [
    'email',
    'address',
    'phone',
  ];

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    /* @var \Drupal\crm_core_contact\Entity\OrganizationType $type */
    $type = $this->entity;
    $form['label'] = [
      '#title' => $this
        ->t('Name'),
      '#type' => 'textfield',
      '#default_value' => $type
        ->label(),
      '#description' => $this
        ->t('The human-readable name of this organization type. It is recommended that this name begin with a capital letter and contain only letters, numbers, and spaces. This name must be unique.'),
      '#required' => TRUE,
      '#size' => 32,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $type
        ->id(),
      '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
      '#machine_name' => [
        'exists' => 'Drupal\\crm_core_contact\\Entity\\OrganizationType::load',
        'source' => [
          'label',
        ],
      ],
      '#description' => $this
        ->t('A unique machine-readable name for this organization type. It must only contain lowercase letters, numbers, and underscores.'),
    ];
    $form['description'] = [
      '#title' => $this
        ->t('Description'),
      '#type' => 'textarea',
      '#default_value' => $type
        ->getDescription(),
      '#description' => $this
        ->t('Describe this organization type.'),
    ];

    // Primary fields section.
    $form['primary_fields_container'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Primary Fields'),
      '#description' => $this
        ->t('Primary fields are used to tell other modules what fields to use for common communications tasks such as sending an email, addressing an envelope, etc. Use the fields below to indicate the primary fields for this organization type.'),
    ];
    $options = [];
    if ($type) {

      /** @var \Drupal\Core\Entity\EntityFieldManager $field_manager */
      $field_manager = \Drupal::service('entity_field.manager');
      $instances = $field_manager
        ->getFieldDefinitions('crm_core_organization', $type
        ->id());
      foreach ($instances as $instance) {
        $options[$instance
          ->getName()] = $instance
          ->getLabel();
      }
    }
    foreach ($this->defaultPrimaryFields as $primary_field) {
      $form['primary_fields_container'][$primary_field] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Primary @field field', [
          '@field' => $primary_field,
        ]),
        '#default_value' => empty($type
          ->getPrimaryFields()[$primary_field]) ? '' : $type
          ->getPrimaryFields()[$primary_field],
        '#empty_value' => '',
        '#empty_option' => $this
          ->t('--Please Select--'),
        '#options' => $options,
      ];
    }
    return $this
      ->protectBundleIdElement($form);
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);
    $actions['submit']['#value'] = $this
      ->t('Save organization type');
    $actions['delete']['#title'] = $this
      ->t('Delete organization type');
    return $actions;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $id = trim($form_state
      ->getValue('id'));

    // '0' is invalid, since elsewhere we check it using empty().
    if ($id == '0') {
      $form_state
        ->setErrorByName('id', $this
        ->t("Invalid machine-readable name. Enter a name other than %invalid.", [
        '%invalid' => $id,
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $primary_fields = [];
    foreach ($this->defaultPrimaryFields as $field) {
      $primary_fields[$field] = $form_state
        ->getValue($field);
    }
    $this->entity
      ->set('primary_fields', $primary_fields);
    $status = $this->entity
      ->save();
    if ($status == SAVED_UPDATED) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('The organization type %name has been updated.', [
        '%name' => $this->entity
          ->label(),
      ]));
    }
    elseif ($status == SAVED_NEW) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('The organization type %name has been added.', [
        '%name' => $this->entity
          ->label(),
      ]));
      $this
        ->logger('crm_core_individual')
        ->notice('Added organization type %name.', [
        '%name' => $this->entity
          ->label(),
      ]);
    }
    $form_state
      ->setRedirect('entity.crm_core_organization_type.collection');
  }

}

Classes

Name	Description
OrganizationTypeForm	Class OrganizationTypeForm.