You are here

Home » API reference » Profile Complete Percent 8 » PCPForm.php

class PCPForm in Profile Complete Percent 8

Provides a PCP configuration form.

Hierarchy

Expanded class hierarchy of PCPForm

1 string reference to 'PCPForm'
pcp.routing.yml in ./pcp.routing.yml
pcp.routing.yml

File

src/Form/PCPForm.php, line 15

Namespace

Drupal\pcp\Form
View source 
class PCPForm extends ConfigFormBase {

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManager
   */
  protected $entityFieldManager;

  /**
   * PCPForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Entity\EntityFieldManager $entity_field_manager
   *   The entity field manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityFieldManager $entity_field_manager) {
    parent::__construct($config_factory);
    $this->entityFieldManager = $entity_field_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('pcp.settings');
    $form['general_setting'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('General Setting'),
    ];
    $form['general_setting']['hide_pcp_block_on_complete'] = [
      '#type' => 'checkbox',
      '#option' => [
        '1',
      ],
      '#default_value' => $config
        ->get('hide_block_on_complete'),
      '#title' => $this
        ->t('Hide Block When Complete.'),
      '#description' => $this
        ->t('When a user reaches 100% complete of their profile, do you want the profile complete percent block to go away? If so, check this box on.'),
    ];
    $form['general_setting']['field_order'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Profile Fields Order'),
      '#options' => [
        '0' => $this
          ->t('Random'),
        '1' => $this
          ->t('Fixed'),
      ],
      '#default_value' => $config
        ->get('field_order') ?: 0,
      '#description' => $this
        ->t('Select to show which field come first.'),
    ];
    $form['general_setting']['open_field_link'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Profile Fields Open Link'),
      '#options' => [
        '0' => $this
          ->t('Same Window'),
        '1' => $this
          ->t('New Window'),
      ],
      '#default_value' => $config
        ->get('open_link') ?: 0,
      '#description' => $this
        ->t('Select to open field link in browser.'),
    ];
    $form['core_field_setting'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Core Profile Field Settings'),
    ];
    $fields = array_filter($this->entityFieldManager
      ->getFieldDefinitions('user', 'user'), function ($field_definition) {
      return $field_definition instanceof FieldConfigInterface;
    });
    $user_field = [];
    foreach ($fields as $key => $value) {

      // TODO Check/fix loading field labels in the right language.
      $user_field[$key] = $fields[$key]
        ->label();
    }
    $form['core_field_setting']['profile_fields'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Profile Fields'),
      '#options' => $user_field,
      '#default_value' => $config
        ->get('profile_fields') ?: [],
      '#description' => $this
        ->t('Checking a profile field below will add that field to the logic of the complete percentage.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('pcp.settings');
    $config
      ->set('field_order', $form_state
      ->getValue('field_order'))
      ->set('open_link', $form_state
      ->getValue('open_field_link'))
      ->set('hide_block_on_complete', $form_state
      ->getValue('hide_pcp_block_on_complete'))
      ->set('profile_fields', $form_state
      ->getValue('profile_fields'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending 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
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.
PCPForm::$entityFieldManager protected property The entity field manager.
PCPForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
PCPForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
PCPForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PCPForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PCPForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
PCPForm::__construct public function PCPForm constructor. Overrides ConfigFormBase::__construct
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.