Update version no, refine src code comments.

gabordemooij · Mar 28, 2021 · e31aad3 · e31aad3
1 parent 45332d4
commit e31aad3
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/RedBeanPHP/Facade.php b/RedBeanPHP/Facade.php
@@ -29,7 +29,7 @@
  * RedBean Facade
  *
  * Version Information
- * RedBean Version @version 5.6
+ * RedBean Version @version 5.7
  *
  * This class hides the object landscape of
  * RedBeanPHP behind a single letter class providing
@@ -49,7 +49,7 @@ class Facade
 	/**
 	 * RedBeanPHP version constant.
 	 */
-	const C_REDBEANPHP_VERSION = '5.6';
+	const C_REDBEANPHP_VERSION = '5.7';
 
 	/**
 	 * @var ToolBox

diff --git a/RedBeanPHP/Functions.php b/RedBeanPHP/Functions.php
@@ -79,6 +79,13 @@ function array_flatten( $array )
 
 /**
  * Function pstr() generates [ $value, \PDO::PARAM_STR ]
+ * Ensures that your parameter is being treated as a string.
+ *
+ * Usage:
+ *
+ * <code>
+ * R::find('book', 'title = ?', [ pstr('1') ]);
+ * </code>
  */
 if ( !function_exists( 'pstr' ) ) {
 
@@ -91,6 +98,13 @@ function pstr( $value )
 
 /**
  * Function pint() generates [ $value, \PDO::PARAM_INT ]
+ * Ensures that your parameter is being treated as an integer.
+ *
+ * Usage:
+ *
+ * <code>
+ * R::find('book', ' pages > ? ', [ pint(2) ] );
+ * </code>
  */
 if ( !function_exists( 'pint' ) ) {
 

diff --git a/RedBeanPHP/Plugin/SQN.php b/RedBeanPHP/Plugin/SQN.php
@@ -12,8 +12,10 @@
  *
  * Usage:
  *
+ * <code>
  * R::sqn('shop<product<price'); - left joins shop, product and price
  * R::sqn('book<<tag'); - doubly left joins book, and tag using book_tag
+ * </code>
  *
  * SQN assumes id fields follow the following conventions:
  *
@@ -23,7 +25,9 @@
  *
  * SQN can also generate additional aliases:
  *
+ * <code>
  * R::sqn( ..., 'area/x,y;place/x,y' ) - area_x area_y place_x place_y
+ * </code>
  *
  * @author  Gabor de Mooij
  * @license BSD/GPLv2

diff --git a/RedBeanPHP/QueryWriter/AQueryWriter.php b/RedBeanPHP/QueryWriter/AQueryWriter.php
@@ -115,8 +115,10 @@ abstract class AQueryWriter
 	 * For instance to add  ROW_FORMAT=DYNAMIC to all MySQL tables
 	 * upon creation:
 	 *
+	 * <code>
 	 * $sql = $writer->getDDLTemplate( 'createTable', '*' );
 	 * $writer->setDDLTemplate( 'createTable', '*', $sql . '  ROW_FORMAT=DYNAMIC ' );
+	 * </code>
 	 *
 	 * For property-specific templates set $beanType to:
 	 * account.username -- then the template will only be applied to SQL statements relating