You are here

Home » API reference » Access by Reference 8 » access_by_ref_settings_form.php

class access_by_ref_settings_form in Access by Reference 8

Configure example settings for this site.

Hierarchy

Expanded class hierarchy of access_by_ref_settings_form

1 string reference to 'access_by_ref_settings_form'
access_by_ref.routing.yml in ./access_by_ref.routing.yml
access_by_ref.routing.yml

File

src/Form/access_by_ref_settings_form.php, line 13

Namespace

Drupal\access_by_ref\Form
View source 
class access_by_ref_settings_form extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'access_by_ref.settings',
    ];
  }
  function getBundlesList($type = 'node') {

    /** @var  $entityManager \Drupal\Core\Entity\EntityTypeBundleInfoInterface  **/
    $entityManager = \Drupal::service('entity_type.bundle.info');
    $bundles = $entityManager
      ->getBundleInfo($type);
    foreach ($bundles as $key => &$item) {
      $bundles[$key] = $item['label'];
    }
    return $bundles;
  }
  function flush_twig() {

    // Wipe the Twig PHP Storage cache. ABR needed.
    PhpStorageFactory::get('twig')
      ->deleteAll();
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Query the database for the set of configured access methods.
    $sql = 'SELECT * FROM {access_by_ref} ORDER BY node_type, reference_type';
    $result = \Drupal::database()
      ->query($sql);
    $contentTypesList = $this
      ->getBundlesList('node');
    $ntype_fields = array();
    $allFields = array();
    $allFieldData = array();
    foreach ($contentTypesList as $key => $label) {
      $myFields = $this
        ->fieldDataFetch($key);
      unset($myFields['body']);
      $ntype_fields[$key] = $myFields;
      $allFields = array_merge($allFields, $myFields);
      $myTypes = $this
        ->fieldDataFetch($key, 'node', 'omni');
      $allFieldData = array_merge($allFieldData, $myTypes);
    }
    $parFields = array();
    $paragraphsTypesList = $this
      ->getBundlesList('paragraph');
    foreach ($paragraphsTypesList as $key => $label) {
      $myFields = $this
        ->fieldDataFetch($key, 'paragraph');
      $ntype_fields[$key] = $myFields;
      $allFields = array_merge($allFields, $myFields);
      $parFields = array_merge($parFields, $myFields);
      $myTypes = $this
        ->fieldDataFetch($key, 'paragraph', 'omni');
      $allFieldData = array_merge($allFieldData, $myTypes);
    }
    $ufields = $this
      ->fieldDataFetch('user', 'user');
    $allFields = array_merge($allFields, $ufields);
    $ufieldtypes = $this
      ->fieldDataFetch('user', 'user', 'omni');
    $allFieldData = array_merge($allFieldData, $ufieldtypes);

    // Put in alpha order.
    asort($allFields);

    // Put in alpha order.
    asort($parFields);
    $form = array();
    $form['#attached']['drupalSettings']['ctypes'] = $contentTypesList;
    $form['#attached']['drupalSettings']['ufields'] = $ufields;
    $form['#attached']['drupalSettings']['parfields'] = $parFields;
    $form['#attached']['drupalSettings']['fields'] = $ntype_fields;
    $form['#attached']['drupalSettings']['fieldData'] = $allFieldData;
    $form['#attached']['library'][] = 'access_by_ref/configform';
    $rows = array(
      'new' => array(
        'id' => 'new',
      ),
    );
    while ($row = $result
      ->fetchAssoc()) {
      $rows[] = $row;
    }
    $info = "<p>This module extends update permissions to modules not owned by the current user. It works in several modes. The current user may update if:\n            <ul>\n            <li><b>User Referenced:</b> If a user is referenced in the relevant user reference field</li>\n            <li><b>User Mail:</b> If the user's email matches (case insensitive) the email entered in the referenced email field</li>\n            <li><b>Profile Value:</b> IIf the value in the user's profile matches the value in the controlling field</li>\n            <li><b>Link to Parent:</b> <i>Best Choice</i> The user has edit rights over a node referenced in the controlling field</li>";

    // <li><b>Link FROM Parent:</b> <i>Risky</i> The node is referenced from a node the user can edit. If the user can edit that field, it gives them extensive control over site content</li>
    // <li><b>Secret Code:</b> <i>Experimental</i> The URL includes a parameter that matches the value of the field. E.g. ?field_foo=bar</li>
    $info .= "</ul></p>";
    $info .= "<p>These accesses will only be available to a user with the Access By Reference permissions, so be sure to set those</p>";
    $info .= "<p><b>To Use:</b> Select the content type to be controlled, and then the type of access you want to grant. Choose the field that will contain the effective data or link. In case we are looking for matched values, such as the 'Profile Value', specify in the Extra Field the field in the User Profile that has to match</p>";
    $form['info'] = array(
      '#type' => 'item',
      '#markup' => $info,
    );
    $headers = array(
      'Managed Content Type',
      'Reference Type',
      'Controlling Field',
      'Extra Data',
      'Delete',
    );
    $types = array(
      'user' => 'User referenced',
      'user_mail' => "User's Mail",
      'shared' => 'Profile Value',
      'inherit' => 'Link to Parent',
    );
    $form['abr'] = array(
      '#type' => 'table',
      '#id' => 'abrTable',
      '#caption' => $this
        ->t('See and Review Access by Reference'),
      '#header' => $headers,
    );
    foreach ($rows as $row) {
      $form['abr']['id:' . $row['id']] = array(
        'ctype' => array(
          '#empty_option' => '-select-',
          '#type' => 'select',
          '#attributes' => array(
            'class' => array(
              'ctype',
            ),
          ),
          '#options' => $contentTypesList,
          '#size' => 1,
          '#default_value' => array_key_exists('node_type', $row) ? $row['node_type'] : [],
        ),
        'rtype' => array(
          '#type' => 'select',
          '#empty_option' => '-select-',
          '#attributes' => array(
            'class' => array(
              'rtype',
            ),
          ),
          '#options' => $types,
          '#size' => 1,
          '#default_value' => array_key_exists('reference_type', $row) ? $row['reference_type'] : [],
        ),
        'field' => array(
          '#type' => 'select',
          '#empty_option' => '-select-',
          '#attributes' => array(
            'class' => array(
              'fields',
            ),
          ),
          '#options' => $allFields,
          //$ntype_fields[$row['node_type']],
          '#size' => 1,
          '#default_value' => array_key_exists('node_field', $row) ? $row['node_field'] : [],
        ),
        'extra' => array(
          '#type' => 'select',
          '#attributes' => array(
            'class' => array(
              'extra',
            ),
          ),
          '#options' => $allFields,
          //$ntype_fields[$row['node_type']],
          '#default_value' => array_key_exists('reference_data', $row) ? $row['reference_data'] : [],
          '#size' => 1,
        ),
        'cbox' => array(
          '#type' => 'checkbox',
          '#attributes' => array(
            'class' => array(
              'cbox',
            ),
          ),
        ),
      );
    }

    // Add a submit button that handles the submission of the form.
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
      '#description' => $this
        ->t('Submit, #type = submit'),
    ];
    return $form;
  }
  public function fieldDataFetch($contentType, $bundle = 'node', $property = 'label') {

    /** @var  $entityFieldManager  \Drupal\Core\Entity\EntityFieldManagerInterface  **/
    $entityFieldManager = \Drupal::service('entity_field.manager');
    $fields = [];
    if (!empty($contentType)) {
      $fields = array_filter($entityFieldManager
        ->getFieldDefinitions($bundle, $contentType), function ($field_definition) {
        return $field_definition instanceof FieldConfigInterface;
      });
    }
    switch ($property) {
      case 'label':
        foreach ($fields as $key => &$field) {
          $fields[$key] = $field
            ->label();
        }
        break;
      case 'type':
        foreach ($fields as $key => &$field) {
          $fields[$key] = $field
            ->getType();
        }
        break;
      case 'handler':
        foreach ($fields as $key => &$field) {
          $fields[$key] = $field
            ->getSetting('handler');
        }
        break;
      case 'omni':
        foreach ($fields as $key => &$field) {
          $vals = array(
            'handler' => $field
              ->getSetting('handler'),
            'type' => $field
              ->getType(),
            'label' => $field
              ->label(),
          );
          $fields[$key] = $vals;
        }
        break;
    }
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Retrieve the configuration
    $vals = $form_state
      ->getValues()['abr'];
    foreach ($vals as $key => $row) {
      $sql = '';
      $id = explode(':', $key)[1];
      $cbox = $row['cbox'];

      // Delete this.
      if ($cbox == 1) {
        $sql = "DELETE FROM {access_by_ref} WHERE `id` = :rowid";
        $result = \Drupal::database()
          ->query($sql, array(
          ':rowid' => $id,
        ));
        break;

        // go to next row
      }
      unset($row['cbox']);

      // remove it from the array
      $parms = array_combine(array(
        ':node_type',
        ':reference_type',
        ':node_field',
        ':reference_data',
      ), $row);

      // unused array, set it to a string to avoid an error
      $parms[':reference_data'] = '';
      if ($id == 'new' && strlen($parms[':node_type']) > 3 && strlen($parms[':reference_type']) > 3) {
        $sql = "INSERT INTO {access_by_ref} (`node_type`, `node_field`, `reference_type`, `reference_data`) VALUES ( :node_type, :node_field, :reference_type, :reference_data)";
      }
      else {
        if ($id !== 'new') {

          // it's an update
          $sql = "UPDATE {access_by_ref} SET `node_type` = :node_type, `node_field`= :node_field, `reference_type`=:reference_type, `reference_data` = :reference_data\n            WHERE `id` = :id ";

          // Add that parm.
          $parms[':id'] = $id;
        }
      }

      // okay, now run the query
      if ($sql !== '') {
        $result = \Drupal::database()
          ->query($sql, $parms);
      }
    }

    // Flush the cache.
    $this
      ->flush_twig();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
access_by_ref_settings_form::buildForm public function Form constructor. Overrides FormInterface::buildForm
access_by_ref_settings_form::fieldDataFetch public function
access_by_ref_settings_form::flush_twig function
access_by_ref_settings_form::getBundlesList function
access_by_ref_settings_form::getEditableConfigNames protected function
access_by_ref_settings_form::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
access_by_ref_settings_form::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.