diff --git a/src/Form/ConfigForm.php b/src/Form/ConfigForm.php index d276f96..e794983 100644 --- a/src/Form/ConfigForm.php +++ b/src/Form/ConfigForm.php @@ -29,19 +29,19 @@ class ConfigForm extends ConfigFormBase { public function buildForm(array $form, FormStateInterface $form_state) { $vocabularies = Vocabulary::loadMultiple(); if (!count($vocabularies)) { - $form['body'] = array( + $form['body'] = [ '#markup' => $this->t('You must create a vocabulary before you can use - tac_lite.', array(':url' => \Drupal::url('entity.taxonomy_vocabulary.add_form'))), - ); + tac_lite.', [':url' => \Drupal::url('entity.taxonomy_vocabulary.add_form')]), + ]; return $form; } else { $settings = $this->configFactory->get('tac_lite.settings'); - $options = array(); + $options = []; foreach ($vocabularies as $vocab) { $options[$vocab->get('vid')] = $vocab->get('name'); } - $form['tac_lite_categories'] = array( + $form['tac_lite_categories'] = [ '#type' => 'select', '#title' => $this->t('Vocabularies'), '#default_value' => $settings->get('tac_lite_categories'), @@ -49,29 +49,29 @@ class ConfigForm extends ConfigFormBase { '#description' => $this->t('Select one or more vocabularies to control privacy.
Use caution with hierarchical (nested) taxonomies as visibility settings may cause problems on node edit forms.
Do not select free tagging vocabularies, they are not supported.'), '#multiple' => TRUE, '#required' => TRUE, - ); - $scheme_options = array(); + ]; + $scheme_options = []; // Currently only view, edit, delete permissions possible, so 7 // permutations will be more than enough. for ($i = 1; $i < 8; $i++) { $scheme_options[$i] = $i; } - $form['tac_lite_schemes'] = array( + $form['tac_lite_schemes'] = [ '#type' => 'select', '#title' => $this->t('Number of Schemes'), '#description' => $this->t('Each scheme allows for a different set of permissions. For example, use scheme 1 for read-only permission; scheme 2 for read and update; scheme 3 for delete; etc. Additional schemes increase the size of your node_access table, so use no more than you need.'), '#default_value' => $settings->get('tac_lite_schemes'), '#options' => $scheme_options, '#required' => TRUE, - ); - $form['tac_lite_rebuild'] = array( + ]; + $form['tac_lite_rebuild'] = [ '#type' => 'checkbox', '#title' => $this->t('Rebuild content permissions now'), // Default false because usually only needed after scheme // has been changed. '#default_value' => FALSE, '#description' => $this->t('Do this once, after you have fully configured access by taxonomy.'), - ); + ]; } return parent::buildForm($form, $form_state); } @@ -96,9 +96,9 @@ class ConfigForm extends ConfigFormBase { node_access_rebuild(TRUE); } else { - drupal_set_message($this->t('Do not forget to rebuild node access permissions after you have configured taxonomy-based access.', array( + drupal_set_message($this->t('Do not forget to rebuild node access permissions after you have configured taxonomy-based access.', [ ':url' => \Drupal::url('node.configure_rebuild_confirm'), - )), 'warning'); + ]), 'warning'); } // And rebuild menus, in case the number of schemes has changed. \Drupal::service('router.builder')->rebuild(); diff --git a/src/Form/SchemeForm.php b/src/Form/SchemeForm.php index f39e86a..bc64c37 100644 --- a/src/Form/SchemeForm.php +++ b/src/Form/SchemeForm.php @@ -37,21 +37,21 @@ class SchemeForm extends ConfigFormBase { $config = self::tacLiteConfig($scheme); $form['#tac_lite_config'] = $config; if (count($vids)) { - $form['tac_lite_config_scheme_' . $scheme] = array('#tree' => TRUE); - $form['tac_lite_config_scheme_' . $scheme]['name'] = array( + $form['tac_lite_config_scheme_' . $scheme] = ['#tree' => TRUE]; + $form['tac_lite_config_scheme_' . $scheme]['name'] = [ '#type' => 'textfield', '#title' => $this->t('Scheme name'), '#description' => $this->t("A human-readable name for administrators to see. For example, 'read' or 'read and write'."), '#default_value' => $config['name'], '#required' => TRUE, - ); + ]; // Currently, only view, update and delete are supported by node_access. - $options = array( + $options = [ 'grant_view' => 'view', 'grant_update' => 'update', 'grant_delete' => 'delete', - ); - $form['tac_lite_config_scheme_' . $scheme]['perms'] = array( + ]; + $form['tac_lite_config_scheme_' . $scheme]['perms'] = [ '#type' => 'select', '#title' => $this->t('Permissions'), '#multiple' => TRUE, @@ -59,45 +59,45 @@ class SchemeForm extends ConfigFormBase { '#default_value' => $config['perms'], '#description' => $this->t('Select which permissions are granted by this scheme.
Note when granting update, it is best to enable visibility on all terms. Otherwise a user may unknowingly remove invisible terms while editing a node.'), '#required' => FALSE, - ); + ]; - $form['tac_lite_config_scheme_' . $scheme]['unpublished'] = array( + $form['tac_lite_config_scheme_' . $scheme]['unpublished'] = [ '#type' => 'checkbox', '#title' => $this->t('Apply to unpublished content'), '#description' => $this->t('If checked, permissions in this scheme will apply to unpublished content. If this scheme includes the view permission, then unpublished nodes will be visible to users whose roles would grant them access to the published node.'), '#default_value' => $config['unpublished'], - ); + ]; - $form['tac_lite_config_scheme_' . $scheme]['term_visibility'] = array( + $form['tac_lite_config_scheme_' . $scheme]['term_visibility'] = [ '#type' => 'checkbox', '#title' => $this->t('Visibility'), '#description' => $this->t('If checked, this scheme determines whether a user can view terms. Note the view permission in the select field above refers to node visibility. This checkbox refers to term visibility, for example in a content edit form or tag cloud.'), '#default_value' => $config['term_visibility'], - ); + ]; - $form['helptext'] = array( + $form['helptext'] = [ '#type' => 'markup', '#markup' => $this->t('To grant to an individual user, visit the access by taxonomy tab on the account edit page.'), '#prefix' => '

', '#suffix' => '

', - ); - $form['helptext2'] = array( + ]; + $form['helptext2'] = [ '#type' => 'markup', '#markup' => $this->t('To grant by role, select the terms below.'), '#prefix' => '

', '#suffix' => '

', - ); + ]; $vocabularies = Vocabulary::loadMultiple(); $all_defaults = $settings->get('tac_lite_grants_scheme_' . $scheme); - $form['tac_lite_grants_scheme_' . $scheme] = array('#tree' => TRUE); + $form['tac_lite_grants_scheme_' . $scheme] = ['#tree' => TRUE]; foreach ($roles as $rid => $role) { $role_name = $role->get('label'); - $form['tac_lite_grants_scheme_' . $scheme][$rid] = array( + $form['tac_lite_grants_scheme_' . $scheme][$rid] = [ '#type' => 'details', '#tree' => TRUE, - '#title' => Html::escape($this->t('Grant permission by role: :role', array(':role' => $role_name))), + '#title' => Html::escape($this->t('Grant permission by role: :role', [':role' => $role_name])), '#open' => TRUE, - ); + ]; $defaults = isset($all_defaults[$rid]) ? $all_defaults[$rid] : NULL; foreach ($vids as $vid) { // Build a taxonomy select form element for this vocab. @@ -106,7 +106,7 @@ class SchemeForm extends ConfigFormBase { $form['tac_lite_grants_scheme_' . $scheme][$rid][$vid] = self::tacLiteTermSelect($v, $default_values); } } - $form['tac_lite_rebuild'] = array( + $form['tac_lite_rebuild'] = [ '#type' => 'checkbox', '#title' => $this->t('Rebuild content permissions now'), // Default false because usually only needed after scheme has @@ -114,15 +114,15 @@ class SchemeForm extends ConfigFormBase { '#default_value' => FALSE, '#description' => $this->t('Do this once, after you have fully configured access by taxonomy.'), '#weight' => 9, - ); + ]; } else { - $form['tac_lite_help'] = array( + $form['tac_lite_help'] = [ '#type' => 'markup', '#prefix' => '

', '#suffix' => '

', - '#markup' => $this->t('First, select one or more vocabularies on the settings tab. Then, return to this page to complete configuration.', array(':url' => \Drupal::url('tac_lite.administration'))), - ); + '#markup' => $this->t('First, select one or more vocabularies on the settings tab. Then, return to this page to complete configuration.', [':url' => \Drupal::url('tac_lite.administration')]), + ]; } return parent::buildForm($form, $form_state); @@ -142,7 +142,7 @@ class SchemeForm extends ConfigFormBase { node_access_rebuild(TRUE); } else { - drupal_set_message($this->t('Do not forget to rebuild node access permissions after you have configured taxonomy-based access.', array(':url' => \Drupal::url('node.configure_rebuild_confirm'))), 'warning'); + drupal_set_message($this->t('Do not forget to rebuild node access permissions after you have configured taxonomy-based access.', [':url' => \Drupal::url('node.configure_rebuild_confirm')]), 'warning'); } parent::submitForm($form, $form_state); } @@ -153,12 +153,12 @@ class SchemeForm extends ConfigFormBase { $settings = \Drupal::config('tac_lite.settings'); $config = $settings->get('tac_lite_config_scheme_' . $scheme); $config['name'] = !empty($config['name']) ? $config['name'] : NULL; - $config['perms'] = !empty($config['perms']) ? $config['perms'] : array(); - $config += array( + $config['perms'] = !empty($config['perms']) ? $config['perms'] : []; + $config += [ 'term_visibility' => (isset($config['perms']['grant_view']) && $config['perms']['grant_view']), 'unpublished' => FALSE, 'realm' => 'tac_lite_scheme_' . $scheme, - ); + ]; return $config; } /** @@ -170,24 +170,24 @@ class SchemeForm extends ConfigFormBase { * An array of values to use for the default_value argument for this * form element. */ - public static function tacLiteTermSelect($v, $default_values = array()) { + public static function tacLiteTermSelect($v, $default_values = []) { $tree = \Drupal::entityManager()->getStorage('taxonomy_term')->loadTree($v->get('vid')); - $options = array(0 => ''); + $options = [0 => '']; if ($tree) { foreach ($tree as $term) { $choice = new \stdClass(); - $choice->option = array($term->tid => str_repeat('-', $term->depth) . $term->name); + $choice->option = [$term->tid => str_repeat('-', $term->depth) . $term->name]; $options[] = $choice; } } - $field_array = array( + $field_array = [ '#type' => 'select', '#title' => $v->get('name'), '#default_value' => $default_values, '#options' => $options, '#multiple' => TRUE, '#description' => $v->get('description'), - ); + ]; return $field_array; } diff --git a/src/Form/UserAccessForm.php b/src/Form/UserAccessForm.php index 8dee8b3..99e9886 100644 --- a/src/Form/UserAccessForm.php +++ b/src/Form/UserAccessForm.php @@ -40,18 +40,18 @@ class UserAccessForm extends ConfigFormBase { if ($config['term_visibility']) { $perms[] = $this->t('term visibility'); } - $form['tac_lite'][$config['realm']] = array( + $form['tac_lite'][$config['realm']] = [ '#type' => 'details', '#title' => $config['name'], - '#description' => $this->t('This scheme controls %perms.', array('%perms' => implode(' and ', $perms))), + '#description' => $this->t('This scheme controls %perms.', ['%perms' => implode(' and ', $perms)]), '#open' => TRUE, '#tree' => TRUE, - ); + ]; // Create a form element for each vocabulary. foreach ($vids as $vid) { $v = $vocabularies[$vid]; - $default_values = array(); - $data = \Drupal::service('user.data')->get('tac_lite', $user, 'tac_lite_scheme_' . $i) ?: array(); + $default_values = []; + $data = \Drupal::service('user.data')->get('tac_lite', $user, 'tac_lite_scheme_' . $i) ?: []; if (!empty($data) && $data[$vid]) { $default_values = $data[$vid]; } @@ -61,20 +61,20 @@ class UserAccessForm extends ConfigFormBase { } } } - $form['tac_lite'][0] = array( + $form['tac_lite'][0] = [ '#type' => 'markup', '#markup' => '

' . $this->t('You may grant this user access based on the schemes and terms below. These permissions are in addition to role based grants on scheme settings pages.', - array(':url' => \Drupal::url('tac_lite.scheme_1'))) . "

\n", + [':url' => \Drupal::url('tac_lite.scheme_1')]) . "

\n", '#weight' => -1, - ); + ]; } else { - $form['tac_lite_help'] = array( + $form['tac_lite_help'] = [ '#type' => 'markup', '#prefix' => '

', '#suffix' => '

', - '#markup' => $this->t('First, select one or more vocabularies on the settings page. Then, return to this page to complete configuration.', array(':url' => \Drupal::url('tac_lite.administration'))), - ); + '#markup' => $this->t('First, select one or more vocabularies on the settings page. Then, return to this page to complete configuration.', [':url' => \Drupal::url('tac_lite.administration')]), + ]; } return parent::buildForm($form, $form_state); } diff --git a/src/Plugin/Derivative/SchemeLocalTask.php b/src/Plugin/Derivative/SchemeLocalTask.php index 03ca1c0..05a499b 100644 --- a/src/Plugin/Derivative/SchemeLocalTask.php +++ b/src/Plugin/Derivative/SchemeLocalTask.php @@ -12,18 +12,18 @@ class SchemeLocalTask extends DeriverBase { * {@inheritdoc} */ public function getDerivativeDefinitions($base_plugin_definition) { - $this->derivatives = array(); + $this->derivatives = []; $config = \Drupal::config('tac_lite.settings'); $schemes = $config->get('tac_lite_schemes'); for ($i = 1; $i <= $schemes; $i++) { $scheme = $config->get('tac_lite_config_scheme_' . $i); $title = $scheme['name'] ? $scheme['name'] : 'Scheme ' . $i; - $this->derivatives[] = array( + $this->derivatives[] = [ 'title' => $title, 'route_name' => 'tac_lite.scheme_' . $i, 'base_route' => 'tac_lite.administration', 'weight' => $i, - ); + ]; } return $this->derivatives; } diff --git a/src/Routing/TacLiteSchemes.php b/src/Routing/TacLiteSchemes.php index c11e058..b3f11b9 100644 --- a/src/Routing/TacLiteSchemes.php +++ b/src/Routing/TacLiteSchemes.php @@ -12,7 +12,7 @@ class TacLiteSchemes { * {@inheritdoc} */ public function routes() { - $routes = array(); + $routes = []; $config = \Drupal::config('tac_lite.settings'); $schemes = $config->get('tac_lite_schemes'); for ($i = 1; $i <= $schemes; $i++) { @@ -20,15 +20,15 @@ class TacLiteSchemes { // Path to attach this route to. '/admin/config/people/tac_lite/scheme_' . $i, // Route defaults. - array( + [ '_form' => '\Drupal\tac_lite\Form\SchemeForm', '_title' => 'Access by Taxonomy', 'scheme' => $i, - ), + ], // Route requirements. - array( + [ '_permission' => 'administer tac_lite', - ) + ] ); } return $routes; diff --git a/tac_lite.module b/tac_lite.module index 40c1cce..0a6df21 100644 --- a/tac_lite.module +++ b/tac_lite.module @@ -27,21 +27,21 @@ function tac_lite_help($route_name, RouteMatchInterface $route_match) { $output .= '

' . t('There are several steps required to set up Taxonomy Access Control Lite.') . '

'; $output .= '
    '; $output .= '
  1. ' . t("Define one or more vocabularies whose terms will control which users have access. For example, you could define a vocabulary called 'Privacy' with terms 'Public' and 'Private'.") . '
    2. '; - $output .= '
  2. ' . t('Tell this module which vocabularies control privacy :url', array( + $output .= '
  3. ' . t('Tell this module which vocabularies control privacy :url', [ ':url' => $admin_tac_lite_url, - )) . '
    4. '; + ]) . ''; $output .= '
  4. ' . t('Configure one or more schemes. simple site may need only one scheme which grants view permission. A more complex site might require additional schemes for update and delete. Each scheme associates roles and terms. Users will be granted priviliges based on their role and the terms with which nodes are tagged.') . '
    5. '; - $output .= '
  5. ' . t('When settings are correct, rebuild node_access permissions.', array( + $output .= '
  6. ' . t('When settings are correct, rebuild node_access permissions.', [ ':url' => \Drupal::url('node.configure_rebuild_confirm'), - )) . '
    7. '; + ]) . ''; $output .= '
  7. ' . t('Optionally, grant access to individual users. (See the access by taxonomy tab, under user -> edit.)') . '
    8. '; $output .= '
'; $output .= '

' . t('Troubleshooting:.') . '

'; return $output; } @@ -54,7 +54,7 @@ function tac_lite_node_access_records(NodeInterface $node) { if (count($tids)) { // If we're here, the node has terms associated with it which restrict // access to the node. - $grants = array(); + $grants = []; $settings = \Drupal::config('tac_lite.settings'); $schemes = $settings->get('tac_lite_schemes'); for ($i = 1; $i <= $schemes; $i++) { @@ -63,7 +63,7 @@ function tac_lite_node_access_records(NodeInterface $node) { // if requested in the scheme. if ($node->isPublished() || $config['unpublished']) { foreach ($tids as $tid) { - $grant = array( + $grant = [ 'realm' => $config['realm'], // Use term id as grant id. 'gid' => $tid, @@ -71,7 +71,7 @@ function tac_lite_node_access_records(NodeInterface $node) { 'grant_update' => 0, 'grant_delete' => 0, 'priority' => 0, - ); + ]; foreach ($config['perms'] as $perm) { $grant[$perm] = 1; } @@ -86,7 +86,7 @@ function tac_lite_node_access_records(NodeInterface $node) { * Gets terms from a node that belong to vocabularies selected. */ function _tac_lite_get_terms($node) { - $tids = array(); + $tids = []; // Get the vids that tac_lite cares about. $config = \Drupal::config('tac_lite.settings'); $vids = $config->get('tac_lite_categories') ? array_keys($config->get('tac_lite_categories')) : NULL; @@ -106,10 +106,10 @@ function _tac_lite_get_terms($node) { } } elseif (\Drupal::currentUser()->hasPermission('administer tac_lite')) { - drupal_set_message(t('tac_lite.module enabled, but not configured. No tac_lite terms associated with :title.', array( + drupal_set_message(t('tac_lite.module enabled, but not configured. No tac_lite terms associated with :title.', [ ':admin_url' => \Drupal::url('tac_lite.administration'), ':title' => $node->getTitle(), - ) + ] )); } return $tids; @@ -153,7 +153,7 @@ function tac_lite_node_get_terms($node) { * requested op. */ function tac_lite_node_grants(AccountInterface $account, $op) { - $grants = array(); + $grants = []; $settings = \Drupal::config('tac_lite.settings'); $schemes = $settings->get('tac_lite_schemes'); for ($i = 1; $i <= $schemes; $i++) { @@ -176,11 +176,11 @@ function _tac_lite_user_tids($account, $scheme, $config) { // Grant id 0 is reserved for nodes which were not given a grant id // when they were created. By adding 0 to the grant id, we let the // user view those nodes. - $grants = array(0); + $grants = [0]; $config = \Drupal::config('tac_lite.settings'); $schemes = $config->get('tac_lite_schemes'); for ($i = 1; $i <= $schemes; $i++) { - $data = \Drupal::service('user.data')->get('tac_lite', $account->id(), 'tac_lite_scheme_' . $i) ?: array(); + $data = \Drupal::service('user.data')->get('tac_lite', $account->id(), 'tac_lite_scheme_' . $i) ?: []; if (count($data)) { foreach ($data as $tids) { if (count($tids)) { @@ -193,7 +193,7 @@ function _tac_lite_user_tids($account, $scheme, $config) { // Add per-role grants in addition to per-user grants. $settings = \Drupal::config('tac_lite.settings'); $defaults = $settings->get('tac_lite_grants_scheme_' . $scheme); - $defaults = $defaults ? $defaults : array(); + $defaults = $defaults ? $defaults : []; $roles = $account->getRoles(); foreach ($roles as $rid) { if (isset($defaults[$rid]) && count($defaults[$rid])) { @@ -229,7 +229,7 @@ function tac_lite_query_term_access_alter(AlterableInterface $query) { } // The terms this user is allowed to see. $term_visibility = FALSE; - $tids = array(); + $tids = []; for ($i = 1; $i <= $schemes; $i++) { $config = SchemeForm::tacLiteConfig($i); if ($config['term_visibility']) { diff --git a/tac_lite_create/tac_lite_create.module b/tac_lite_create/tac_lite_create.module index e54fed5..38dc0a9 100644 --- a/tac_lite_create/tac_lite_create.module +++ b/tac_lite_create/tac_lite_create.module @@ -23,12 +23,12 @@ function tac_lite_create_form_alter(&$form, FormStateInterface $form_state, $for $config = $form['#tac_lite_config']; $scheme = isset($build_info['args'][0]) ? $build_info['args'][0] : NULL; if (!empty($form['tac_lite_config_scheme_' . $scheme])) { - $form['tac_lite_config_scheme_' . $scheme]['tac_lite_create'] = array( + $form['tac_lite_config_scheme_' . $scheme]['tac_lite_create'] = [ '#type' => 'checkbox', '#title' => 'Visibility on create and edit forms', '#default_value' => isset($config['tac_lite_create']) ? $config['tac_lite_create'] : FALSE, '#description' => t('Show terms when creating content. This does not control which users can create a given content type. This does control which terms appear on the node edit forms.
Note that schemes granting update permission (above) imply visibility on forms as well.'), - ); + ]; } } elseif ($base_form == 'node_form') { @@ -39,7 +39,7 @@ function tac_lite_create_form_alter(&$form, FormStateInterface $form_state, $for } $settings = \Drupal::config('tac_lite.settings'); $vids = $settings->get('tac_lite_categories'); - $tids = array(); + $tids = $term_fields = []; $schemes = $settings->get('tac_lite_schemes'); for ($i = 1; $i <= $schemes; $i++) { $config = SchemeForm::tacLiteConfig($i); @@ -49,7 +49,6 @@ function tac_lite_create_form_alter(&$form, FormStateInterface $form_state, $for } } // Go through all of the fields in the system to find the ones we want use. - $term_fields = array(); $storage = $form_state->getStorage(); $form_display = $storage['form_display'] ?: NULL; $bundle = $form_display ? $form_display->get('bundle') : NULL;