In the process of upgrading my database calls from D6 to D7, I need to understand the new API. For instance the pager and tablesort handling has been changed. The API page https://api.drupal.org/api/drupal/includes%21database%21database.inc/gro... mentions that I should "consider using the PagerDefault Extender [...], and the Tablesort Extender [...]" but it took some time to find any more info about them.

I propose that those two names are made hyperlinks to https://drupal.org/node/508796 and https://drupal.org/node/1848372 respectively. Thanks in advance.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon’s picture

Title: Links to Extender documentation in Database API » Add links to Extender documentation in Database API
Version: 7.x-dev » 8.x-dev
Category: Feature request » Task
Issue tags: +Novice, +Needs backport to D7

Good idea... probably we should at least put @see references to PagerDefault and TableSort in this documentation. The 8.x docs need to be fixed up first -- there PagerDefault is turning into a link but not TableSort (missing the full namespaced class name). It still could use an @see.

StephaneQ’s picture

Status: Active » Needs review
FileSize
959 bytes

Here is a D8 patch

jhodgdon’s picture

Status: Needs review » Needs work

Looks good! The only thing is that @see lines should be at the bottom of the doc block, and they should be separated from the other documentation by a blank line.

jhodgdon’s picture

Actually... Given that those links apply to this paragraph only, it might make more sense to put them into the text of that paragraph directly rather than an @see (which will go into a See Also section at the bottom of the page, with no context). You can just put the URL in there and it will turn into a link on drupal.org.

StephaneQ’s picture

Status: Needs work » Needs review
FileSize
957 bytes
993 bytes
jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Perfect, thanks!

jhodgdon’s picture

Version: 8.x-dev » 7.x-dev
Status: Reviewed & tested by the community » Patch (to be ported)

Thanks again! Committed to 8.x. We need something similar for 7.x, but obviously without the namespaces and with the correct 7.x class names.

StephaneQ’s picture

FileSize
881 bytes

Here is the D7 patch

StephaneQ’s picture

Status: Patch (to be ported) » Needs review

Oops, forgot status

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks! I'll get this in.

jhodgdon’s picture

Status: Reviewed & tested by the community » Fixed

Thanks again! Committed to 7.x.

Status: Fixed » Closed (fixed)

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