Commit 53e54ea6 authored by alexpott's avatar alexpott

Issue #2722763 by drnikki: Select::extend doc incorrectly says to use base name

parent 770fcd0f
......@@ -6,11 +6,11 @@
* Interface for extendable query objects.
*
* "Extenders" follow the "Decorator" OOP design pattern. That is, they wrap
* and "decorate" another object. In our case, they implement the same interface
* as select queries and wrap a select query, to which they delegate almost all
* operations. Subclasses of this class may implement additional methods or
* override existing methods as appropriate. Extenders may also wrap other
* extender objects, allowing for arbitrarily complex "enhanced" queries.
* and "decorate" another object. In our case, they implement the same
* interface as select queries and wrap a select query, to which they delegate
* almost all operations. Subclasses of this class may implement additional
* methods or override existing methods as appropriate. Extenders may also wrap
* other extender objects, allowing for arbitrarily complex "enhanced" queries.
*/
interface ExtendableInterface {
......@@ -18,9 +18,12 @@
* Enhance this object by wrapping it in an extender object.
*
* @param $extender_name
* The base name of the extending class. The base name will be checked
* against the current database connection to allow driver-specific subclasses
* as well, using the same logic as the query objects themselves.
* The fully-qualified name of the extender class, without the leading '\'
* (for example, Drupal\my_module\myExtenderClass). The extender name will
* be checked against the current database connection to allow
* driver-specific subclasses as well, using the same logic as the query
* objects themselves.
*
* @return \Drupal\Core\Database\Query\ExtendableInterface
* The extender object, which now contains a reference to this object.
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment