phpdoc
[m6w6/pq-gateway] / lib / pq / Mapper / RefPropertyInterface.php
1 <?php
2
3 namespace pq\Mapper;
4
5 interface RefPropertyInterface extends PropertyInterface
6 {
7 /**
8 * Define the referred class
9 * @param string $class
10 * @return RefPropertyInterface
11 */
12 function to($class);
13
14 /**
15 * Check whether this mapping refers to $class
16 * @param string $class
17 * @return bool
18 */
19 function references($class);
20
21 /**
22 * Define the foreign key name as defined by pq\Gateway\Table\Reference
23 * @param string $ref
24 * @return RefPropertyInterface
25 */
26 function by($ref);
27
28 /**
29 * Check whether this mapping referes to a foreign key
30 * @param string $ref
31 * @return bool
32 */
33 function on($ref);
34 }