diff --git a/pathauto.api.php b/pathauto.api.php index c58c05ca..32c2aa68 100644 --- a/pathauto.api.php +++ b/pathauto.api.php @@ -8,10 +8,9 @@ use Drupal\Core\Language\Language; /** - * @todo Update for 8.x-1.x + * You might want to check examples of integration in pathauto.pathauto.inc. * - * It may be helpful to review some examples of integration from - * pathauto.pathauto.inc. + * @todo Update for 8.x-1.x * * Pathauto works by using tokens in path patterns. Thus the simplest * integration is just to provide tokens. Token support is provided by Drupal diff --git a/pathauto.module b/pathauto.module index b029f944..8e6b73a6 100644 --- a/pathauto.module +++ b/pathauto.module @@ -13,7 +13,7 @@ /** * @file - * Main file for the Pathauto module, which automatically generates aliases for content. + * Main file of the Pathauto module, which auto-generates content aliases. * * @ingroup pathauto */ @@ -147,8 +147,7 @@ function pathauto_entity_base_field_info(EntityTypeInterface $entity_type) { } /** - * Validate the pattern field, to ensure it doesn't contain any characters that - * are invalid in URLs. + * Validate the pattern field to ensure it contains only valid URL characters. */ function pathauto_pattern_validate($element, FormStateInterface $form_state) { diff --git a/src/AliasCleaner.php b/src/AliasCleaner.php index 14c515bc..0e572102 100644 --- a/src/AliasCleaner.php +++ b/src/AliasCleaner.php @@ -253,7 +253,6 @@ public function cleanString($string, array $options = []) { $output = strtr($output, $this->cleanStringCache['punctuation']); } - // Reduce strings to letters and numbers. if ($this->cleanStringCache['reduce_ascii']) { $output = preg_replace('/[^a-zA-Z0-9\/]+/', $this->cleanStringCache['separator'], $output); diff --git a/src/AliasCleanerInterface.php b/src/AliasCleanerInterface.php index 24832cc7..cbdc8743 100644 --- a/src/AliasCleanerInterface.php +++ b/src/AliasCleanerInterface.php @@ -3,7 +3,7 @@ namespace Drupal\pathauto; /** - * @todo add class comment. + * Defines interface that sets required methods for classes. */ interface AliasCleanerInterface { @@ -13,7 +13,7 @@ interface AliasCleanerInterface { * Performs the following alterations: * - Trim duplicate, leading, and trailing back-slashes. * - Trim duplicate, leading, and trailing separators. - * - Shorten to a desired length and logical position based on word boundaries. + * - Shortens to a desired length at logical word boundaries. * * @param string $alias * A string with the URL alias to clean up. @@ -52,7 +52,7 @@ public function getCleanSeparators($string, $separator = NULL); * - Replace whitespace with the separator character. * - Trim duplicate, leading, and trailing separators. * - Convert to lower-case. - * - Shorten to a desired length and logical position based on word boundaries. + * - Shortens to a set length at logical word boundaries. * * This function should *not* be called on URL alias or path strings * because it is assumed that they are already clean. diff --git a/src/AliasStorageHelperInterface.php b/src/AliasStorageHelperInterface.php index 818b7fff..28d80b0e 100644 --- a/src/AliasStorageHelperInterface.php +++ b/src/AliasStorageHelperInterface.php @@ -102,13 +102,13 @@ public function loadBySourcePrefix($source); /** * Returns the count of url aliases for the source. * - * @param $source + * @param string $source * An internal Drupal path prefix. * * @return int * Number of url aliases for the source. */ - public function countBySourcePrefix($source); + public function countBySourcePrefix(string $source); /** * Returns the total count of the url aliases. diff --git a/src/Commands/PathautoCommands.php b/src/Commands/PathautoCommands.php index 9821ebfb..8abf2129 100644 --- a/src/Commands/PathautoCommands.php +++ b/src/Commands/PathautoCommands.php @@ -105,7 +105,7 @@ public function generateAliases($action = NULL, array $types = NULL) { } /** - * Delete URL aliases + * Delete URL aliases. * * @command pathauto:aliases-delete * diff --git a/src/Entity/PathautoPattern.php b/src/Entity/PathautoPattern.php index 9e4a58eb..d3cf1620 100644 --- a/src/Entity/PathautoPattern.php +++ b/src/Entity/PathautoPattern.php @@ -407,7 +407,7 @@ public function applies($object) { * object. * * @param string $token - * A ":" delimited set of tokens representing + * A ":" delimited set of tokens representing. * @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts * The array of available contexts. * diff --git a/src/Form/PathautoSettingsForm.php b/src/Form/PathautoSettingsForm.php index c6df22a2..0481095a 100644 --- a/src/Form/PathautoSettingsForm.php +++ b/src/Form/PathautoSettingsForm.php @@ -3,17 +3,10 @@ namespace Drupal\pathauto\Form; use Drupal\Component\Utility\Html; -use Drupal\Core\Config\ConfigFactoryInterface; -use Drupal\Core\Entity\EntityFieldManagerInterface; -use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Entity\FieldableEntityInterface; -use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Form\ConfigFormBase; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Url; -use Drupal\pathauto\AliasCleanerInterface; -use Drupal\pathauto\AliasStorageHelperInterface; -use Drupal\pathauto\AliasTypeManager; use Drupal\pathauto\PathautoGeneratorInterface; use Symfony\Component\DependencyInjection\ContainerInterface; diff --git a/src/Form/PatternEditForm.php b/src/Form/PatternEditForm.php index b763a1b4..eefc17e8 100644 --- a/src/Form/PatternEditForm.php +++ b/src/Form/PatternEditForm.php @@ -109,7 +109,7 @@ public function buildForm(array $form, FormStateInterface $form_state) { '#suffix' => '', ]; - // if there is no type yet, stop here. + // If there is no type yet, stop here. if ($this->entity->getType()) { $alias_type = $this->entity->getAliasType(); diff --git a/src/PathautoFieldItemList.php b/src/PathautoFieldItemList.php index 300675ca..7d542718 100644 --- a/src/PathautoFieldItemList.php +++ b/src/PathautoFieldItemList.php @@ -4,10 +4,13 @@ use Drupal\path\Plugin\Field\FieldType\PathFieldItemList; +/** + * PathautoFieldItemList specific logic for new entities to create a new alias. + */ class PathautoFieldItemList extends PathFieldItemList { /** - * @{inheritdoc} + * Function duplicates logic to call a method on each item in a list. */ protected function delegateMethod($method) { // @todo Workaround until this is fixed, see @@ -27,7 +30,7 @@ protected function delegateMethod($method) { } /** - * @{inheritdoc} + * Sets the `pathauto` value to `CREATE` for a new entity. */ protected function computeValue() { parent::computeValue(); diff --git a/src/PathautoGeneratorInterface.php b/src/PathautoGeneratorInterface.php index 1c19bcb9..afb52e92 100644 --- a/src/PathautoGeneratorInterface.php +++ b/src/PathautoGeneratorInterface.php @@ -73,13 +73,13 @@ public function createEntityAlias(EntityInterface $entity, $op); /** * Creates or updates an alias for the given entity. * - * @param EntityInterface $entity + * @param \Drupal\Core\Entity\EntityInterface $entity * Entity for which to update the alias. * @param string $op * The operation performed (insert, update) * @param array $options * - force: will force updating the path - * - language: the language for which to create the alias + * - language: the language for which to create the alias. * * @return array|null * - An array with alias data in case the alias has been created or updated. diff --git a/src/PathautoPatternListBuilder.php b/src/PathautoPatternListBuilder.php index dd3ed4ef..eb35e07e 100644 --- a/src/PathautoPatternListBuilder.php +++ b/src/PathautoPatternListBuilder.php @@ -37,7 +37,7 @@ public function buildHeader() { * {@inheritdoc} */ public function buildRow(EntityInterface $entity) { - /* @var \Drupal\pathauto\PathautoPatternInterface $entity */ + /** @var \Drupal\pathauto\PathautoPatternInterface $entity */ $row['label'] = $entity->label(); $row['pattern']['#markup'] = $entity->getPattern(); $row['type']['#markup'] = $entity->getAliasType()->getLabel(); diff --git a/src/PathautoWidget.php b/src/PathautoWidget.php index 392e8e82..f048d878 100644 --- a/src/PathautoWidget.php +++ b/src/PathautoWidget.php @@ -24,18 +24,18 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen // @todo Impossible to do this in widget, use another solution /* $form['path'] += array( - '#type' => 'fieldset', - '#title' => $this->t('URL path settings'), - '#collapsible' => TRUE, - '#collapsed' => empty($form['path']['alias']), - '#group' => 'additional_settings', - '#attributes' => array( - 'class' => array('path-form'), - ), - '#access' => \Drupal::currentUser()->hasPermission('create url aliases') || \Drupal::currentUser()->hasPermission('administer url aliases'), - '#weight' => 30, - '#tree' => TRUE, - '#element_validate' => array('path_form_element_validate'), + '#type' => 'fieldset', + '#title' => $this->t('URL path settings'), + '#collapsible' => TRUE, + '#collapsed' => empty($form['path']['alias']), + '#group' => 'additional_settings', + '#attributes' => array( + 'class' => array('path-form'), + ), + '#access' => \Drupal::currentUser()->hasPermission('create url aliases') || \Drupal::currentUser()->hasPermission('administer url aliases'), + '#weight' => 30, + '#tree' => TRUE, + '#element_validate' => array('path_form_element_validate'), );*/ $pattern = \Drupal::service('pathauto.generator')->getPatternByEntity($entity); diff --git a/tests/modules/pathauto_custom_punctuation_test/pathauto_custom_punctuation_test.module b/tests/modules/pathauto_custom_punctuation_test/pathauto_custom_punctuation_test.module index ae95a13f..6649abd9 100644 --- a/tests/modules/pathauto_custom_punctuation_test/pathauto_custom_punctuation_test.module +++ b/tests/modules/pathauto_custom_punctuation_test/pathauto_custom_punctuation_test.module @@ -1,5 +1,9 @@ patterns['forum'] = $this->createPattern('forum', '/forums/[term:name]'); } + /** + * + */ public function testBulkUpdate() { // Create some nodes. $this->nodes = []; diff --git a/tests/src/Functional/PathautoEnablingEntityTypesTest.php b/tests/src/Functional/PathautoEnablingEntityTypesTest.php index 13eb251c..6e1cf5e4 100644 --- a/tests/src/Functional/PathautoEnablingEntityTypesTest.php +++ b/tests/src/Functional/PathautoEnablingEntityTypesTest.php @@ -74,7 +74,7 @@ public function testEnablingEntityTypes() { $edit = [ 'enabled_entity_types[comment]' => TRUE, ]; - $this->submitForm($edit, "Save configuration" ); + $this->submitForm($edit, "Save configuration"); $this->createPattern('comment', '/comment/[comment:body]'); // Create a node, a comment type and a comment entity. diff --git a/tests/src/Functional/PathautoNodeWebTest.php b/tests/src/Functional/PathautoNodeWebTest.php index 2c78d355..283c68b4 100644 --- a/tests/src/Functional/PathautoNodeWebTest.php +++ b/tests/src/Functional/PathautoNodeWebTest.php @@ -119,7 +119,7 @@ public function testNodeEditing() { 'path[0][alias]' => '/should-not-get-created', ]; $this->drupalGet('node/add/page'); - $this->submitForm( $edit, 'Save'); + $this->submitForm($edit, 'Save'); $this->assertNoAliasExists(['alias' => 'should-not-get-created']); $node = $this->drupalGetNodeByTitle($title); $this->assertEntityAlias($node, '/content/automatic-title'); @@ -264,7 +264,6 @@ public function testNodeState() { $this->assertNull(\Drupal::keyValue('pathauto_state.node')->get($node->id()), 'Pathauto state was deleted'); } - /** * Tests that nodes without a Pathauto pattern can set custom aliases. */ diff --git a/tests/src/FunctionalJavascript/PathautoLocaleTest.php b/tests/src/FunctionalJavascript/PathautoLocaleTest.php index dedb7fcf..962865d4 100644 --- a/tests/src/FunctionalJavascript/PathautoLocaleTest.php +++ b/tests/src/FunctionalJavascript/PathautoLocaleTest.php @@ -57,7 +57,8 @@ public function testLanguageAliases() { 'path' => [[ 'alias' => '/english-node', 'pathauto' => FALSE, - ]], + ], + ], ]; $node = $this->drupalCreateNode($node); $english_alias = $this->loadPathAliasByConditions(['alias' => '/english-node', 'langcode' => 'en']); diff --git a/tests/src/FunctionalJavascript/PathautoUiTest.php b/tests/src/FunctionalJavascript/PathautoUiTest.php index c8807ba2..33c1a205 100644 --- a/tests/src/FunctionalJavascript/PathautoUiTest.php +++ b/tests/src/FunctionalJavascript/PathautoUiTest.php @@ -59,6 +59,9 @@ protected function setUp(): void { $this->drupalLogin($this->adminUser); } + /** + * + */ public function testSettingsValidation() { $this->drupalGet('/admin/config/search/path/settings'); @@ -69,6 +72,9 @@ public function testSettingsValidation() { $this->assertSession()->elementAttributeContains('css', '#edit-max-component-length', 'min', '1'); } + /** + * + */ public function testPatternsWorkflow() { $this->drupalPlaceBlock('local_tasks_block', ['id' => 'local-tasks-block']); $this->drupalPlaceBlock('local_actions_block'); diff --git a/tests/src/Kernel/PathautoEntityWithStringIdTest.php b/tests/src/Kernel/PathautoEntityWithStringIdTest.php index 26034b5b..06c00253 100644 --- a/tests/src/Kernel/PathautoEntityWithStringIdTest.php +++ b/tests/src/Kernel/PathautoEntityWithStringIdTest.php @@ -76,7 +76,7 @@ protected function setUp(): void { * @dataProvider entityWithStringIdProvider * * @param string|int $id - * The entity ID + * The entity ID. * @param string $expected_key * The expected key for 'pathauto_state.*' collections. */ diff --git a/tests/src/Kernel/PathautoTokenTest.php b/tests/src/Kernel/PathautoTokenTest.php index 811b85ba..20ef4926 100644 --- a/tests/src/Kernel/PathautoTokenTest.php +++ b/tests/src/Kernel/PathautoTokenTest.php @@ -20,6 +20,9 @@ class PathautoTokenTest extends KernelTestBase { */ protected static $modules = ['system', 'token', 'path_alias', 'pathauto']; + /** + * + */ public function testPathautoTokens() { $this->installConfig(['pathauto']); @@ -36,7 +39,7 @@ public function testPathautoTokens() { $replacements = $this->assertTokens('array', $data, $tokens); // Ensure that the cleanTokenValues() method does not alter this token value. - /* @var \Drupal\pathauto\AliasCleanerInterface $alias_cleaner */ + /** @var \Drupal\pathauto\AliasCleanerInterface $alias_cleaner */ $alias_cleaner = \Drupal::service('pathauto.alias_cleaner'); $alias_cleaner->cleanTokenValues($replacements, $data, []); $this->assertEquals('test-first-arg/array-value', $replacements['[array:join-path]']); @@ -121,6 +124,9 @@ public function assertTokens($type, array $data, array $tokens, array $options = return $replacements; } + /** + * + */ public function mapTokenNames($type, array $tokens = []) { $return = []; foreach ($tokens as $token) {