Skip to content

Commit bbc7ec4

Browse files
committed
Documentation fixes
1 parent 2ccc207 commit bbc7ec4

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/3. Active Table.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ You can add an AND or OR clause to the condition easily:
2525
```php
2626
$condition->and('firstName', 'Barney');
2727
```
28-
The above will produce `'lastName' = ? AND 'firstName' = ?`
28+
The above will produce the PDO equivalent of `lastName = 'Rubble' AND firstName = 'Barney'`
2929

3030
You can also OR in a condition like:
3131
```php
3232
$condition->or('firstName', 'Fred');
3333
```
34-
The above will now produce `'lastName' = ? AND 'firstName' = ? OR 'firstName' = ?`
34+
The above will now produce the PDO equivalent of `lastName = 'Rubble' AND firstName = 'Barney' OR firstName = 'Fred'`
3535

3636
You can parenthesize a condition by adding to another condition:
3737
```php
@@ -43,7 +43,7 @@ $condition = new \PHPFUI\ORM\Condition();
4343
$condition->or($conditionA);
4444
$condition->or($conditionB);
4545
```
46-
The above will produce '('lastName' = ? AND 'firstName' = ?) OR ('lastName' = ? AND 'firstName' = ?)'
46+
The above will produce the PDO equivalent of '(lastName = 'Rubble' AND firstName = 'Barney') OR (lastName = 'Flintstone' AND firstName = 'Fred')'
4747

4848
#### Other operators
4949
You can also make conditions with the following operators as the third parameter to [\PHPFUI\ORM\Condition](http://phpfui.com/?n=PHPFUI%5CORM&c=Condition):
@@ -70,7 +70,7 @@ $condition = new \PHPFUI\ORM\Condition();
7070
$condition->or($conditionA);
7171
$condition->or($conditionB);
7272
```
73-
The above will produce `('lastName' >= ? AND 'lastName' < ?) OR ('lastName' >= ? AND 'lastName' < ?)`
73+
The above will produce the PDO equivalent of `(lastName >= 'R' AND lastName < 'S') OR (lastName >= 'F' AND lastName < 'G')`
7474

7575
The [In](http://phpfui.com/?n=PHPFUI\ORM\Operator&c=In) and [NotIn](http://phpfui.com/?n=PHPFUI\ORM\Operator&c=NotIn) operators require the second parameter to [Condition](http://phpfui.com/?n=PHPFUI\ORM&c=Condition). The [Like](http://phpfui.com/?n=PHPFUI\ORM\Operator&c=Like) and [NotLike](http://phpfui.com/?n=PHPFUI\ORM\Operator&c=NotLike) operators will respect the % and _ characters, but you are responsible for putting them in the correct positions.
7676

docs/4. Cursors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ foreach ($customerTable->getArrayCursor() as $row)
2424
}
2525
```
2626
### DataObjectCursor
27-
A **DataObjectCursor** returns a **DataObject** that uses object notation to access fields. It does not have any settable properties or methods associated with it. It also implements [ArrayAccess](https://www.php.net/manual/en/class.arrayaccess.php), but is not an array. It also implements related
27+
A **DataObjectCursor** returns a **DataObject** that uses object notation to access fields. It does not have any settable properties or methods associated with it. It implements [ArrayAccess](https://www.php.net/manual/en/class.arrayaccess.php), but is not an array. It also can return related records on valid fields.
2828
```php
2929
$customerTable = new \App\Table\Customer();
3030
$customerTable->setWhere(new \PHPFUI\ORM\Condition('first_name', 'Fred'));

docs/7. Validation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PHPFUI\ORM Validation
22
*__Note__: Referenced namespaces in this document refer to the **PHPFUI\ORM** defaults.*
33

4-
Validator is an abstract class for Record validation See [\App\Record\Validation](/System/sayaPhpDocumentation?n=App%5CRecord%5CValidation) namespace for examples.
4+
Validator is an abstract class for Record validation See [\PHPFUI\ORM\Validator](http://phpfui.com/?n=PHPFUI%5CORM&c=Validator) namespace for examples.
55

66
Individual validators are listed in the table below. Validators can be combined. For example, a field can be **required**, and have a **minlength** and **maxlength**. Validators can have parameters. Parameters are separated by a colon (:) and then commas for each separate parameter.
77

0 commit comments

Comments
 (0)