Skip to content

Commit e31aad3

Browse files
committed
Update version no, refine src code comments.
1 parent 45332d4 commit e31aad3

File tree

4 files changed

+22
-2
lines changed

4 files changed

+22
-2
lines changed

Diff for: RedBeanPHP/Facade.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* RedBean Facade
3030
*
3131
* Version Information
32-
* RedBean Version @version 5.6
32+
* RedBean Version @version 5.7
3333
*
3434
* This class hides the object landscape of
3535
* RedBeanPHP behind a single letter class providing
@@ -49,7 +49,7 @@ class Facade
4949
/**
5050
* RedBeanPHP version constant.
5151
*/
52-
const C_REDBEANPHP_VERSION = '5.6';
52+
const C_REDBEANPHP_VERSION = '5.7';
5353

5454
/**
5555
* @var ToolBox

Diff for: RedBeanPHP/Functions.php

+14
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,13 @@ function array_flatten( $array )
7979

8080
/**
8181
* Function pstr() generates [ $value, \PDO::PARAM_STR ]
82+
* Ensures that your parameter is being treated as a string.
83+
*
84+
* Usage:
85+
*
86+
* <code>
87+
* R::find('book', 'title = ?', [ pstr('1') ]);
88+
* </code>
8289
*/
8390
if ( !function_exists( 'pstr' ) ) {
8491

@@ -91,6 +98,13 @@ function pstr( $value )
9198

9299
/**
93100
* Function pint() generates [ $value, \PDO::PARAM_INT ]
101+
* Ensures that your parameter is being treated as an integer.
102+
*
103+
* Usage:
104+
*
105+
* <code>
106+
* R::find('book', ' pages > ? ', [ pint(2) ] );
107+
* </code>
94108
*/
95109
if ( !function_exists( 'pint' ) ) {
96110

Diff for: RedBeanPHP/Plugin/SQN.php

+4
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@
1212
*
1313
* Usage:
1414
*
15+
* <code>
1516
* R::sqn('shop<product<price'); - left joins shop, product and price
1617
* R::sqn('book<<tag'); - doubly left joins book, and tag using book_tag
18+
* </code>
1719
*
1820
* SQN assumes id fields follow the following conventions:
1921
*
@@ -23,7 +25,9 @@
2325
*
2426
* SQN can also generate additional aliases:
2527
*
28+
* <code>
2629
* R::sqn( ..., 'area/x,y;place/x,y' ) - area_x area_y place_x place_y
30+
* </code>
2731
*
2832
* @author Gabor de Mooij
2933
* @license BSD/GPLv2

Diff for: RedBeanPHP/QueryWriter/AQueryWriter.php

+2
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,10 @@ abstract class AQueryWriter
115115
* For instance to add ROW_FORMAT=DYNAMIC to all MySQL tables
116116
* upon creation:
117117
*
118+
* <code>
118119
* $sql = $writer->getDDLTemplate( 'createTable', '*' );
119120
* $writer->setDDLTemplate( 'createTable', '*', $sql . ' ROW_FORMAT=DYNAMIC ' );
121+
* </code>
120122
*
121123
* For property-specific templates set $beanType to:
122124
* account.username -- then the template will only be applied to SQL statements relating

0 commit comments

Comments
 (0)