From 36b712ed0207fcda664012d6175c0bd138b951c1 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Wed, 15 Oct 2014 17:11:12 +0200 Subject: [PATCH] Cell --- pq-gateway/pq/Gateway/Cell.md | 10 ++++++++++ pq-gateway/pq/Gateway/Cell/__construct.md | 16 ++++++++++++++++ pq-gateway/pq/Gateway/Cell/isDirty.md | 11 +++++++++++ pq-gateway/pq/Gateway/Cell/mod.md | 16 ++++++++++++++++ pq-gateway/pq/Gateway/Cell/offsetGet.md | 17 +++++++++++++++++ pq-gateway/pq/Gateway/Cell/offsetIsset.md | 17 +++++++++++++++++ pq-gateway/pq/Gateway/Cell/offsetSet.md | 16 ++++++++++++++++ pq-gateway/pq/Gateway/Cell/offsetUnset.md | 14 ++++++++++++++ pq-gateway/pq/Gateway/Cell/set.md | 14 ++++++++++++++ 9 files changed, 131 insertions(+) create mode 100644 pq-gateway/pq/Gateway/Cell.md create mode 100644 pq-gateway/pq/Gateway/Cell/__construct.md create mode 100644 pq-gateway/pq/Gateway/Cell/isDirty.md create mode 100644 pq-gateway/pq/Gateway/Cell/mod.md create mode 100644 pq-gateway/pq/Gateway/Cell/offsetGet.md create mode 100644 pq-gateway/pq/Gateway/Cell/offsetIsset.md create mode 100644 pq-gateway/pq/Gateway/Cell/offsetSet.md create mode 100644 pq-gateway/pq/Gateway/Cell/offsetUnset.md create mode 100644 pq-gateway/pq/Gateway/Cell/set.md diff --git a/pq-gateway/pq/Gateway/Cell.md b/pq-gateway/pq/Gateway/Cell.md new file mode 100644 index 0000000..1668ab4 --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell.md @@ -0,0 +1,10 @@ +# class pq\Gateway\Cell extends pq\Query\Expressible implements ArrayAccess + +The cell gateway. + +## Properties: + +* protected pq\Gateway\Row $row + The originating row. +* protected bool $dirty + Whether the cell has been modified. diff --git a/pq-gateway/pq/Gateway/Cell/__construct.md b/pq-gateway/pq/Gateway/Cell/__construct.md new file mode 100644 index 0000000..d2361b2 --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell/__construct.md @@ -0,0 +1,16 @@ +# void pq\Gateway\Cell::__construct(pq\Gateway\Row $row, string $name, mixed $data[, bool $dirty = FALSE]) + +Create a new cell gateway. +See pq\Query\Expressible::__construct(). + +## Params: + +* pq\Gateway\Row $row + The originating row. +* string $name + The name of the column. +* mixed $data + The value of the column. +* Optional bool $dirty = FALSE + Whether the data does actually not exist in the database. + diff --git a/pq-gateway/pq/Gateway/Cell/isDirty.md b/pq-gateway/pq/Gateway/Cell/isDirty.md new file mode 100644 index 0000000..4700dda --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell/isDirty.md @@ -0,0 +1,11 @@ +# bool pq\Gateway\Cell::isDirty() + +Whether the data has been modified. + +## Params: + +None. + +## Returns: + +* bool, whether the cell is dirty. diff --git a/pq-gateway/pq/Gateway/Cell/mod.md b/pq-gateway/pq/Gateway/Cell/mod.md new file mode 100644 index 0000000..17ec5bb --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell/mod.md @@ -0,0 +1,16 @@ +# pq\Gateway\Cell pq\Gateway\Cell::mod(mixed $data[, string $op = NULL]) + +Extend the column's value. +Marks the cell as dirty. +See pq\Query\Expressible::mod(). + +## Params: + +* mixed $data + The value to append to the column. +* Optional string $op = NULL + An operator to use for cell modification (defaults to "+" for numerics and "||" for strings). + +## Returns: + +* pq\Gateway\Cell, self. diff --git a/pq-gateway/pq/Gateway/Cell/offsetGet.md b/pq-gateway/pq/Gateway/Cell/offsetGet.md new file mode 100644 index 0000000..bdf71ad --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell/offsetGet.md @@ -0,0 +1,17 @@ +# mixed pq\Gateway\Cell::offsetGet(int $o) + +Implements ArrayAcccess. +Retrieve the value of an array offset. + +## Params: + +* int $o + The offset. + +## Returns: + +* mixed, the value at the offset. + +## Throws: + +* UnexpectedValueException, if the cell's value is not an array. diff --git a/pq-gateway/pq/Gateway/Cell/offsetIsset.md b/pq-gateway/pq/Gateway/Cell/offsetIsset.md new file mode 100644 index 0000000..cfc428e --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell/offsetIsset.md @@ -0,0 +1,17 @@ +# mixed pq\Gateway\Cell::offsetIsset(int $o) + +Implements ArrayAcccess. +Check whether an array offset isset. + +## Params: + +* int $o + The offset. + +## Returns: + +* bool, whether the value at the offset isset. + +## Throws: + +* UnexpectedValueException, if the cell's value is not an array. diff --git a/pq-gateway/pq/Gateway/Cell/offsetSet.md b/pq-gateway/pq/Gateway/Cell/offsetSet.md new file mode 100644 index 0000000..81bf786 --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell/offsetSet.md @@ -0,0 +1,16 @@ +# void pq\Gateway\Cell::offsetSet(int $o, mixed $v) + +Implements ArrayAcccess. +Set or append the value of an array offset. +Marks the cell dirty. + +## Params: + +* int $o + The offset. +* mixed $v + The value. + +## Throws: + +* UnexpectedValueException, if the cell's value is not an array. diff --git a/pq-gateway/pq/Gateway/Cell/offsetUnset.md b/pq-gateway/pq/Gateway/Cell/offsetUnset.md new file mode 100644 index 0000000..1f63154 --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell/offsetUnset.md @@ -0,0 +1,14 @@ +# void pq\Gateway\Cell::offsetUnset(int $o) + +Implements ArrayAcccess. +Unset the value of an array offset. +Marks the cell dirty. + +## Params: + +* int $o + The offset. + +## Throws: + +* UnexpectedValueException, if the cell's value is not an array. diff --git a/pq-gateway/pq/Gateway/Cell/set.md b/pq-gateway/pq/Gateway/Cell/set.md new file mode 100644 index 0000000..1868ec7 --- /dev/null +++ b/pq-gateway/pq/Gateway/Cell/set.md @@ -0,0 +1,14 @@ +# pq\Gateway\Cell pq\Gateway\Cell::set(mixed $data) + +Set a new value. +Marks the cell as dirty. +See pq\Query\Expressible::set(). + +## Params: + +* mixed $data + The new column value. + +## Returns: + +* pq\Gateway\Cell, self. -- 2.30.2