Problem/Motivation

Connection and SelectInterface has escape* methods and the single $string parameter is not documented

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Comments

chx’s picture

Title: Missing doxygen on Connection::escape* » Missing @param doxygen on Connection::escape*
Issue summary: View changes
daffie’s picture

Issue tags: +Novice
rosinegrean’s picture

Status: Active » Fixed

This is already done here Docblock fixes for core/lib/Drupal/Core/Database/Connection.php. It got merged today.

rosinegrean’s picture

Status: Fixed » Needs review
StatusFileSize
new771 bytes

Actually, SelectInterface::escapeField() needed an update too.
Here it goes.

chx’s picture

Status: Needs review » Reviewed & tested by the community

Thanks!

alexpott’s picture

Status: Reviewed & tested by the community » Needs work
+++ b/core/lib/Drupal/Core/Database/Query/SelectInterface.php
@@ -147,10 +147,13 @@ public function escapeLike($string);
+   * @param string $field
+   *   An unsanitized field name.
...
-  public function escapeField($string);
+  public function escapeField($field);

Lets not actually change the parameter name from $string to $field

alexpott’s picture

This would make the implementations inconsistent with the interface.

rosinegrean’s picture

Status: Needs work » Needs review
StatusFileSize
new586 bytes
new799 bytes

I understand, here is the fix for it.

chx’s picture

Status: Needs review » Reviewed & tested by the community

thanks

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Docs are not frozen in beta. Committed 91efdc3 and pushed to 8.0.x. Thanks!

  • alexpott committed 91efdc3 on 8.0.x
    Issue #2540674 by prics: Missing @param doxygen on Connection::escape*
    

Status: Fixed » Closed (fixed)

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