Problem/Motivation

This is a follow up to #2777451: @see references not forming links in documentation. In #9 over there @alexpott suggested fixing or removing the following documentation starting at line 23 in core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php

    * This is collected by DatabaseConnection_pgsql->queryTableInformation(),
    * by introspecting the database.

and at line 123 in core/lib/Drupal/Core/Database/Driver/mysql/Schema.php.

   // @see DatabaseConnection_mysql

Proposed resolution

None yet.

Remaining tasks

Make a patch.

User interface changes

N/A

API changes

N/A

Data model changes

N/A

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

quietone created an issue. See original summary.

shashikant_chauhan’s picture

Status: Active » Needs review
FileSize
769 bytes

replaced the DatabaseConnection_pgsql->queryTableInformation with \Drupal\Core\Database\Driver\pgsql\Schema::queryTableInformation(). Adding patch for it.

daffie’s picture

Status: Needs review » Reviewed & tested by the community

Looks good to me.

xjm’s picture

Status: Reviewed & tested by the community » Needs work

Thanks for working on this!

There's another outdated reference in this pattern in Schema.php:

[drupal | Sun 13:55:11] $ grep -r "DatabaseConnection\_" *
core/lib/Drupal/Core/Database/Driver/mysql/Schema.php:    // @see DatabaseConnection_mysql
core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php:   * This is collected by DatabaseConnection_pgsql->queryTableInformation(),
core/modules/migrate_drupal/tests/fixtures/drupal7.php:  'name' => 'DatabaseConnection_mysql',
core/modules/migrate_drupal/tests/fixtures/drupal7.php:  'name' => 'DatabaseConnection_pgsql',
core/modules/migrate_drupal/tests/fixtures/drupal7.php:  'name' => 'DatabaseConnection_sqlite',

(The last three references are in a Drupal 7 fixture and so do not need to be changed.)

alexpott’s picture

+++ b/core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php
@@ -20,8 +20,9 @@ class Schema extends DatabaseSchema {
-   * This is collected by DatabaseConnection_pgsql->queryTableInformation(),
-   * by introspecting the database.
+   * This is collected by
+   * \Drupal\Core\Database\Driver\pgsql\Schema::queryTableInformation(), by
+   * introspecting the database.
    *
    * @see \Drupal\Core\Database\Driver\pgsql\Schema::queryTableInformation()

Since we've got the @see we don't to use the fully qualified class name because it is redundant. So changing this to Schema::queryTableInformation().

shashikant_chauhan’s picture

Assigned: Unassigned » shashikant_chauhan
Issue summary: View changes
Status: Needs work » Needs review
FileSize
1.43 KB

adding updated patch as suggested.

shashikant_chauhan’s picture

Title: Fix $tableInformation documentation in pgsql schema.php » Fix $tableInformation documentation in pgsql and mysql schema.php
Issue summary: View changes
daffie’s picture

Status: Needs review » Reviewed & tested by the community

I think that this is how @xjm and @alexpott would like to have it.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Since this is docs it can go in both 8.3.x and 8.2.x.

Committed and pushed 178cbb9 to 8.3.x and a51cf37 to 8.2.x. Thanks!

  • alexpott committed 178cbb9 on 8.3.x
    Issue #2791375 by shashikant_chauhan: Fix $tableInformation...

  • alexpott committed a51cf37 on 8.2.x
    Issue #2791375 by shashikant_chauhan: Fix $tableInformation...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.