change phpdoc for BaseLoop::exec method

This commit is contained in:
Manuel Raynaud
2013-09-06 16:34:55 +02:00
parent 5b637598e9
commit 8ba5ef616d

View File

@@ -243,11 +243,24 @@ abstract class BaseLoop
*
* this function have to be implement in your own loop class.
*
* All your parameters are defined in defineArgs() and can be accessible like a class property.
* All loops parameters can be accesible via getter.
*
* for example, ref parameter is accessible through getRef method
*
* @param $pagination
*
* @return mixed
*/
abstract public function exec(&$pagination);
/**
*
* define all args used in your loop
*
*
* example :
*
* public function defineArgs()
* public function getArgDefinitions()
* {
* return new ArgumentCollection(
* Argument::createIntListTypeArgument('id'),
@@ -270,31 +283,6 @@ abstract class BaseLoop
* );
* }
*
* you can retrieve ref value using $this->ref
*
* @param $pagination
*
* @return mixed
*/
abstract public function exec(&$pagination);
/**
*
* define all args used in your loop
*
* array key is your arg name.
*
* example :
*
* return array (
* "ref",
* "id" => "optional",
* "stock" => array(
* "optional",
* "default" => 10
* )
* );
*
* @return \Thelia\Core\Template\Loop\Argument\ArgumentCollection
*/
abstract protected function getArgDefinitions();