projects
/
m6w6
/
pq-gateway
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
|
github
raw
|
inline
| side by side
phpdoc
[m6w6/pq-gateway]
/
lib
/
pq
/
Mapper
/
PropertyInterface.php
diff --git
a/lib/pq/Mapper/PropertyInterface.php
b/lib/pq/Mapper/PropertyInterface.php
index da6ccd32e9ddd4da6c90887fd33b25259367119a..b53e2b8976749737d1a33e8dc5e239bca9610c56 100644
(file)
--- a/
lib/pq/Mapper/PropertyInterface.php
+++ b/
lib/pq/Mapper/PropertyInterface.php
@@
-6,18
+6,66
@@
use pq\Gateway\Row;
interface PropertyInterface
{
interface PropertyInterface
{
+ /**
+ * Write the value for the property from $object into the row to update
+ * @param object $object
+ * @param Row $rowToUpdate
+ * @return null|callable eventual deferred callback
+ */
function write($object, Row $rowToUpdate);
function write($object, Row $rowToUpdate);
+
+ /**
+ * Read the value for the property from $row into the mapped object
+ * @param Row $row
+ * @param object $objectToUpdate
+ * @return null|callable eventual deferred callback
+ */
function read(Row $row, $objectToUpdate);
function read(Row $row, $objectToUpdate);
+ /**
+ * Set the value of the mapped property
+ * @param object $object
+ * @param mixed $value
+ */
function assign($object, $value);
function assign($object, $value);
+
+ /**
+ * Get the value of the mapped property
+ * @param object $object
+ * @return mixed
+ */
function extract($object);
function extract($object);
+ /**
+ * Get the property name
+ * @return string
+ */
function getProperty();
function getProperty();
+ /**
+ * Get the containing map
+ * @return MapInterface
+ */
function getContainer();
function getContainer();
+
+ /**
+ * Set the containing map
+ * @param MapInterface $container
+ * @return Property
+ */
function setContainer(MapInterface $container);
function setContainer(MapInterface $container);
+ /**
+ * Check whether this Property defines $property
+ * @param string $property
+ * @return bool
+ */
function defines($property);
function defines($property);
- function exposes($field);
+ /**
+ * Check whether this property exposes $field
+ * @param string $field
+ * @return bool
+ */
+ function exposes($field);
}
}