Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Database/Query/ExtendableInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Database\Query\ExtendableInterface.
6	*/
7
8	namespace Drupal\Core\Database\Query;
9
10	/**
11	* Interface for extendable query objects.
12	*
13	* "Extenders" follow the "Decorator" OOP design pattern. That is, they wrap
14	* and "decorate" another object. In our case, they implement the same interface
15	* as select queries and wrap a select query, to which they delegate almost all
16	* operations. Subclasses of this class may implement additional methods or
17	* override existing methods as appropriate. Extenders may also wrap other
18	* extender objects, allowing for arbitrarily complex "enhanced" queries.
19	*/
20	interface ExtendableInterface {
21
22	/**
23	* Enhance this object by wrapping it in an extender object.
24	*
25	* @param $extender_name
26	* The base name of the extending class. The base name will be checked
27	* against the current database connection to allow driver-specific subclasses
28	* as well, using the same logic as the query objects themselves.
29	* @return \Drupal\Core\Database\Query\ExtendableInterface
30	* The extender object, which now contains a reference to this object.
31	*/
32	public function extend($extender_name);
33	}