Docblocks

Author: paveljanda

src/NetteDatabaseDataSource.php

@@ -48,7 +48,7 @@ class NetteDatabaseDataSource extends FilterableDataSource implements IDataSourc
 
 	/**
 	 * @param Context $connection
-	 * @param array   $query
+	 * @param array   $sql
 	 */
 	public function __construct(Context $connection, $sql)
 	{
@@ -63,6 +63,10 @@ public function __construct(Context $connection, $sql)
 	}
 
 
+	/**
+	 * Get current sql + query parameters
+	 * @return array
+	 */
 	public function getQuery()
 	{
 		$sql = preg_replace('/_\?\w{13}\?_/', '?', $this->sql);
@@ -71,6 +75,10 @@ public function getQuery()
 	}
 
 
+	/**
+	 * @param string $sql
+	 * @return array
+	 */
 	protected function addParams($sql)
 	{
 		$params = $this->query_parameters;
@@ -81,6 +89,11 @@ protected function addParams($sql)
 	}
 
 
+	/**
+	 * Call Context::query() with current sql + params
+	 * @param  string $sql
+	 * @return Nette\Database\ResultSet
+	 */
 	protected function query($sql)
 	{
 		$sql = preg_replace('/_\?\w{13}\?_/', '?', $sql);
@@ -89,6 +102,12 @@ protected function query($sql)
 	}
 
 
+	/**
+	 * @param  string $column
+	 * @param  mixed $value
+	 * @param  string $operator
+	 * @return void
+	 */
 	protected function applyWhere($column, $value, $operator = '=')
 	{
 		$id = '_?' . uniqid() . '?_';

src/QueryHelper.php

@@ -56,6 +56,9 @@ public function prepare($query)
 	}
 
 
+	/**
+	 * @return string
+	 */
 	public function getCountSelect()
 	{
 		$query = $this->query;
@@ -83,6 +86,11 @@ public function getCountSelect()
 	}
 
 
+	/**
+	 * @param  int $limit
+	 * @param  int $offset
+	 * @return string
+	 */
 	public function limit($limit, $offset)
 	{
 		$this->query['LIMIT'] = [
@@ -94,6 +102,11 @@ public function limit($limit, $offset)
 	}
 
 
+	/**
+	 * @param  string $column
+	 * @param  string $order
+	 * @return string
+	 */
 	public function orderBy($column, $order)
 	{
 		$this->query['ORDER'] = [[
@@ -111,6 +124,12 @@ public function orderBy($column, $order)
 	}
 
 
+	/**
+	 * @param  string $column
+	 * @param  mixed  $value
+	 * @param  string $operator
+	 * @return string
+	 */
 	public function where($column, $value, $operator)
 	{
 		if (empty($this->query['WHERE'])) {
@@ -179,6 +198,10 @@ public function where($column, $value, $operator)
 	}
 
 
+	/**
+	 * @param  string $sql
+	 * @return string
+	 */
 	public function whereSql($sql)
 	{
 		if (empty($this->query['WHERE'])) {