phpdoc update

This commit is contained in:
Etienne Roudeix
2013-07-01 11:19:32 +02:00
parent edc731d139
commit 8ba9a4beef
2 changed files with 25 additions and 8 deletions

View File

@@ -72,6 +72,12 @@ abstract class BaseLoop
return $this->defineArgs()->addArguments($this->getDefaultArgs()); return $this->defineArgs()->addArguments($this->getDefaultArgs());
} }
/**
* @param \ModelCriteria $search
* @param null $pagination
*
* @return array|mixed|\PropelModelPager|\PropelObjectCollection
*/
public function search(\ModelCriteria $search, &$pagination = null) public function search(\ModelCriteria $search, &$pagination = null)
{ {
if($this->page !== null) { if($this->page !== null) {
@@ -81,6 +87,11 @@ abstract class BaseLoop
} }
} }
/**
* @param \ModelCriteria $search
*
* @return array|mixed|\PropelObjectCollection
*/
public function searchWithOffset(\ModelCriteria $search) public function searchWithOffset(\ModelCriteria $search)
{ {
if($this->limit >= 0) { if($this->limit >= 0) {
@@ -91,14 +102,16 @@ abstract class BaseLoop
return $search->find(); return $search->find();
} }
/**
* @param \ModelCriteria $search
* @param $pagination
*
* @return array|\PropelModelPager
*/
public function searchWithPagination(\ModelCriteria $search, &$pagination) public function searchWithPagination(\ModelCriteria $search, &$pagination)
{ {
$pagination = $search->paginate($this->page, $this->limit); $pagination = $search->paginate($this->page, $this->limit);
//$toto = $pagination->haveToPaginate();
//$toto = $pagination->getNbResults();
//$toto2 = $pagination->count();
if($this->page > $pagination->getLastPage()) { if($this->page > $pagination->getLastPage()) {
return array(); return array();
} else { } else {
@@ -128,9 +141,10 @@ abstract class BaseLoop
* *
* you can retrieve ref value using $this->ref * you can retrieve ref value using $this->ref
* *
* @param $pagination
*
* @return mixed * @return mixed
*/ */abstract public function exec(&$pagination);
abstract public function exec(&$pagination);
/** /**
* *
@@ -149,7 +163,7 @@ abstract class BaseLoop
* ) * )
* ); * );
* *
* @return \Thelia\Core\Template\Element\LoopResult * @return \Thelia\Core\Template\Loop\Argument\ArgumentCollection
*/ */
abstract protected function defineArgs(); abstract protected function defineArgs();

View File

@@ -75,6 +75,9 @@ class Category extends BaseLoop
public $random; public $random;
public $exclude; public $exclude;
/**
* @return ArgumentCollection
*/
protected function defineArgs() protected function defineArgs()
{ {
return new ArgumentCollection( return new ArgumentCollection(
@@ -96,7 +99,7 @@ class Category extends BaseLoop
} }
/** /**
* * @param $pagination
* *
* @return \Thelia\Core\Template\Element\LoopResult * @return \Thelia\Core\Template\Element\LoopResult
*/ */