Merge branch 'argument', remote-tracking branch 'origin'

Conflicts:
	core/lib/Thelia/Core/Template/Loop/Category.php
	core/lib/Thelia/Core/Template/Smarty/Plugins/TheliaLoop.php
	core/lib/Thelia/Core/Template/TestLoop/Equal.php
This commit is contained in:
Etienne Roudeix
2013-06-28 14:38:23 +02:00
14 changed files with 491 additions and 175 deletions

View File

@@ -25,7 +25,7 @@ namespace Thelia\Core\Template\Element;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Thelia\Core\Template\Loop\Argument\ArgumentCollection;
use Thelia\Core\Template\Loop\Argument\Argument;
/**
*
@@ -44,6 +44,19 @@ abstract class BaseLoop
*/
public $dispatcher;
public $limit;
public $page;
public $offset;
protected function getDefaultArgs()
{
return array(
Argument::createIntTypeArgument('offset', 0),
Argument::createIntTypeArgument('page'),
Argument::createIntTypeArgument('limit', 10),
);
}
/**
* @param \Symfony\Component\HttpFoundation\Request $request
* @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
@@ -54,6 +67,45 @@ abstract class BaseLoop
$this->dispatcher = $dispatcher;
}
public function getArgs()
{
return $this->defineArgs()->addArguments($this->getDefaultArgs());
}
public function search(\ModelCriteria $search, &$pagination = null)
{
if($this->page !== null) {
return $this->searchWithPagination($search, $pagination);
} else {
return $this->searchWithOffset($search);
}
}
public function searchWithOffset(\ModelCriteria $search)
{
if($this->limit >= 0) {
$search->limit($this->limit);
}
$search->offset($this->offset);
return $search->find();
}
public function searchWithPagination(\ModelCriteria $search, &$pagination)
{
$pagination = $search->paginate($this->page, $this->limit);
//$toto = $pagination->haveToPaginate();
//$toto = $pagination->getNbResults();
//$toto2 = $pagination->count();
if($this->page > $pagination->getLastPage()) {
return array();
} else {
return $pagination;
}
}
/**
*
* this function have to be implement in your own loop class.
@@ -78,7 +130,7 @@ abstract class BaseLoop
*
* @return mixed
*/
abstract public function exec();
abstract public function exec(&$pagination);
/**
*
@@ -97,8 +149,8 @@ abstract class BaseLoop
* )
* );
*
* @return ArgumentCollection
* @return \Thelia\Core\Template\Element\LoopResult
*/
abstract public function defineArgs();
abstract protected function defineArgs();
}

View File

@@ -22,6 +22,9 @@
/*************************************************************************************/
namespace Thelia\Core\Template\Loop\Argument;
use Thelia\Type\TypeCollection;
use Thelia\Type;
/**
*
* @author Etienne Roudeix <eroudeix@openstudio.fr>
@@ -42,4 +45,43 @@ class Argument
$this->mandatory = $mandatory ? true : false;
$this->default = $default;
}
public static function createAnyTypeArgument($name, $default=null, $mandatory=false, $empty=true)
{
return new Argument(
$name,
new TypeCollection(
new Type\AnyType()
),
$default,
$mandatory,
$empty
);
}
public static function createIntTypeArgument($name, $default=null, $mandatory=false, $empty=true)
{
return new Argument(
$name,
new TypeCollection(
new Type\IntType()
),
$default,
$mandatory,
$empty
);
}
public static function createIntListTypeArgument($name, $default=null, $mandatory=false, $empty=true)
{
return new Argument(
$name,
new TypeCollection(
new Type\IntListType()
),
$default,
$mandatory,
$empty
);
}
}

View File

@@ -35,9 +35,7 @@ class ArgumentCollection implements \Iterator
public function __construct()
{
foreach(func_get_args() as $argument) {
$this->addArgument($argument);
}
$this->addArguments(func_get_args());
}
public function isEmpty()
@@ -45,6 +43,20 @@ class ArgumentCollection implements \Iterator
return count($this->arguments) == 0;
}
/**
* @param array $argumentList
*
* @return ArgumentCollection
*/
public function addArguments(array $argumentList)
{
foreach($argumentList as $argument) {
$this->addArgument($argument);
}
return $this;
}
/**
* @param Argument $argument
*

View File

@@ -51,8 +51,6 @@ use Thelia\Type;
* * by default results are sorting by position ascending
* - random : if 1, random results. Default value is 0
* - exclude : all category id you want to exclude (as for id, an integer or a "string list" can be used)
* - limit : number of results. Default value is 10
* - offset : at witch id start the search
*
* example :
*
@@ -76,83 +74,24 @@ class Category extends BaseLoop
public $order;
public $random;
public $exclude;
public $limit;
public $offset;
public function defineArgs()
protected function defineArgs()
{
return new ArgumentCollection(
new Argument(
'id',
new TypeCollection(
new Type\IntListType()
)
),
new Argument(
'parent',
new TypeCollection(
new Type\IntType()
)
),
new Argument(
'current',
new TypeCollection(
new Type\IntType()
)
),
new Argument(
'not_empty',
new TypeCollection(
new Type\IntType()
),
0
),
new Argument(
'visible',
new TypeCollection(
new Type\IntType()
),
1
),
new Argument(
'link',
new TypeCollection(
new Type\AnyType()
)
),
Argument::createIntListTypeArgument('id'),
Argument::createIntTypeArgument('parent'),
Argument::createIntTypeArgument('current'),
Argument::createIntTypeArgument('not_empty', 0),
Argument::createIntTypeArgument('visible', 1),
Argument::createAnyTypeArgument('link'),
new Argument(
'order',
new TypeCollection(
new Type\EnumType('alpha', 'alpha_reverse', 'reverse')
)
),
new Argument(
'random',
new TypeCollection(
new Type\AnyType()
),
0
),
new Argument(
'exclude',
new TypeCollection(
new Type\IntListType()
)
),
new Argument(
'limit',
new TypeCollection(
new Type\IntType()
),
10
),
new Argument(
'offset',
new TypeCollection(
new Type\IntType()
),
0
)
Argument::createIntTypeArgument('random', 0),
Argument::createIntListTypeArgument('exclude')
);
}
@@ -161,7 +100,7 @@ class Category extends BaseLoop
*
* @return \Thelia\Core\Template\Element\LoopResult
*/
public function exec()
public function exec(&$pagination)
{
$search = CategoryQuery::create();
@@ -187,11 +126,7 @@ class Category extends BaseLoop
$search->filterByLink($this->link);
}
if ($this->limit > -1) {
$search->limit($this->limit);
}
$search->filterByVisible($this->visible);
$search->offset($this->offset);
switch ($this->order) {
case "alpha":
@@ -220,7 +155,7 @@ class Category extends BaseLoop
*/
$search->joinWithI18n($this->request->getSession()->get('locale', 'en_US'), \Criteria::INNER_JOIN);
$categories = $search->find();
$categories = $this->search($search, $pagination);
$loopResult = new LoopResult();

View File

@@ -35,6 +35,7 @@ use Symfony\Component\EventDispatcher\EventDispatcherInterface;
class TheliaLoop implements SmartyPluginInterface
{
protected static $pagination = null;
protected $loopDefinition = array();
@@ -48,6 +49,20 @@ class TheliaLoop implements SmartyPluginInterface
$this->dispatcher = $dispatcher;
}
/**
* @param $loopId
*
* @return \PropelModelPager
*/
public static function getPagination($loopId)
{
if(!empty(self::$pagination[$loopId])) {
return self::$pagination[$loopId];
} else {
return null;
}
}
/**
* Process {loop name="loop name" type="loop type" ... } ... {/loop} block
*
@@ -75,11 +90,13 @@ class TheliaLoop implements SmartyPluginInterface
$this->getLoopArgument($loop, $params);
$loopResults = $loop->exec();
self::$pagination[$name] = null;
$loopResults = $loop->exec(self::$pagination[$name]);
$template->assignByRef($name, $loopResults);
} else {
} else {
$loopResults = $template->getTemplateVars($name);
$loopResults->next();
@@ -95,7 +112,8 @@ class TheliaLoop implements SmartyPluginInterface
$template->assign('__COUNT__', 1 + $loopResults->key());
$template->assign('__TOTAL__', $loopResults->getCount());
$repeat = $loopResults->valid();
//$repeat = $loopResults->valid();
$repeat = true;
}
@@ -135,13 +153,62 @@ class TheliaLoop implements SmartyPluginInterface
*/
public function theliaIfLoop($params, $content, $template, &$repeat)
{
// When encountering close tag, check if loop has results.
if ($repeat === false) {
return $this->checkEmptyLoop($params, $template) ? '' : $content;
}
}
/**
* Process {pageloop rel="loopname"} ... {/pageloop} block
*
* @param $params
* @param $content
* @param $template
* @param $repeat
*
* @return string
* @throws \InvalidArgumentException
*/
public function theliaPageLoop($params, $content, $template, &$repeat)
{
if (empty($params['rel']))
throw new \InvalidArgumentException("Missing 'rel' parameter in page loop");
$loopName = $params['rel'];
// Find loop results in the current template vars
$loopResults = $template->getTemplateVars($loopName);
if (empty($loopResults)) {
throw new \InvalidArgumentException("Loop $loopName is not defined.");
}
// Find pagination
$pagination = self::getPagination($loopName);
if ($pagination === null) {
throw new \InvalidArgumentException("Loop $loopName : no pagination found.");
}
if ($content === null) {
$page = 1;
} else {
$page = $template->getTemplateVars('PAGE');
$page++;
}
if ($page <= $pagination->getLastPage()) {
$template->assign('PAGE', $page);
$template->assign('CURRENT', $pagination->getPage());
$template->assign('LAST', $pagination->getLastPage());
$repeat = true;
}
if ($content !== null) {
return $content;
}
}
/**
* Check if a loop has returned results. The loop shoud have been executed before, or an
* InvalidArgumentException is thrown
@@ -174,8 +241,8 @@ class TheliaLoop implements SmartyPluginInterface
*
* @param string $name
* @return \Thelia\Core\Template\Element\BaseLoop
* @throws \Thelia\Tpex\Exception\InvalidElementException
* @throws \Thelia\Tpex\Exception\ElementNotFoundException
* @throws InvalidElementException
* @throws ElementNotFoundException
*/
protected function createLoopInstance($name)
{
@@ -200,22 +267,16 @@ class TheliaLoop implements SmartyPluginInterface
/**
* Returns the value of a loop argument.
*
* @param unknown $loop a BaseLoop instance
* @param unknown $smartyParam
* @param BaseLoop $loop a BaseLoop instance
* @param $smartyParam
* @throws \InvalidArgumentException
*/
protected function getLoopArgument(BaseLoop $loop, $smartyParam)
{
$defaultItemsParams = array('required' => true);
$shortcutItemParams = array('optional' => array('required' => false));
$errorCode = 0;
$faultActor = array();
$faultDetails = array();
$argumentsCollection = $loop->defineArgs();
$argumentsCollection = $loop->getArgs();
foreach( $argumentsCollection as $argument ) {
$value = isset($smartyParam[$argument->name]) ? $smartyParam[$argument->name] : null;
@@ -272,7 +333,7 @@ class TheliaLoop implements SmartyPluginInterface
* "myLoop" => "My\Own\Loop"
* );
*
* @param array $loops
* @param array $loopDefinition
* @throws \InvalidArgumentException if loop name already exists
*/
public function setLoopList(array $loopDefinition)
@@ -298,6 +359,7 @@ class TheliaLoop implements SmartyPluginInterface
new SmartyPluginDescriptor('block', 'loop' , $this, 'theliaLoop'),
new SmartyPluginDescriptor('block', 'elseloop' , $this, 'theliaElseloop'),
new SmartyPluginDescriptor('block', 'ifloop' , $this, 'theliaIfLoop'),
new SmartyPluginDescriptor('block', 'pageloop' , $this, 'theliaPageLoop'),
);
}
}

View File

@@ -113,17 +113,11 @@ class ArgumentTest extends \PHPUnit_Framework_TestCase
$arguments = \PHPUnit_Framework_Assert::readAttribute($collection, 'arguments');
$collection->rewind();
while ($collection->valid()) {
$argument = $collection->current();
foreach($collection as $key => $argument) {
$this->assertEquals(
$argument,
$arguments[$collection->key()]
$arguments[$key]
);
$collection->next();
}
}
}

View File

@@ -21,31 +21,20 @@
/* */
/*************************************************************************************/
namespace Thelia\Core\Template\TestLoop;
namespace Thelia\Tests\Type;
use Thelia\Tpex\Element\TestLoop\BaseTestLoop;
use Thelia\Type\AnyType;
/**
*
* TestLoop equal, test if value and variable are equal
* @author Etienne Roudeix <eroudeix@openstudio.fr>
*
* example :
*
* <TEST_equal test="equal" variable="3" value="1">
* Result display here if variable and value are equal
* </TEST_equal>
* Result display here if variable and value are not equal
* <//TEST_equal>
*
* Class Equal
* @package Thelia\Core\Template\TestLoop
* @author Manuel Raynaud <mraynaud@openstudio.fr>
*/
class Equal extends BaseTestLoop
class AnyTypeTest extends \PHPUnit_Framework_TestCase
{
public function exec($variable, $value)
public function testAnyType()
{
return $variable == $value;
$anyType = new AnyType();
$this->assertTrue($anyType->isValid(md5(rand(1000, 10000))));
}
}

View File

@@ -0,0 +1,43 @@
<?php
/*************************************************************************************/
/* */
/* Thelia */
/* */
/* Copyright (c) OpenStudio */
/* email : info@thelia.net */
/* web : http://www.thelia.net */
/* */
/* This program is free software; you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation; either version 3 of the License */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/*************************************************************************************/
namespace Thelia\Tests\Type;
use Thelia\Type\EnumType;
/**
*
* @author Etienne Roudeix <eroudeix@openstudio.fr>
*
*/
class EnumTypeTest extends \PHPUnit_Framework_TestCase
{
public function testEnumType()
{
$enumType = new EnumType(array("cat", "dog"));
$this->assertTrue($enumType->isValid('cat'));
$this->assertTrue($enumType->isValid('dog'));
$this->assertFalse($enumType->isValid('monkey'));
$this->assertFalse($enumType->isValid('catdog'));
}
}

View File

@@ -0,0 +1,42 @@
<?php
/*************************************************************************************/
/* */
/* Thelia */
/* */
/* Copyright (c) OpenStudio */
/* email : info@thelia.net */
/* web : http://www.thelia.net */
/* */
/* This program is free software; you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation; either version 3 of the License */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/*************************************************************************************/
namespace Thelia\Tests\Type;
use Thelia\Type\FloatType;
/**
*
* @author Etienne Roudeix <eroudeix@openstudio.fr>
*
*/
class FloatTypeTest extends \PHPUnit_Framework_TestCase
{
public function testFloatType()
{
$floatType = new FloatType();
$this->assertTrue($floatType->isValid('1.1'));
$this->assertTrue($floatType->isValid(2.2));
$this->assertFalse($floatType->isValid('foo'));
}
}

View File

@@ -0,0 +1,42 @@
<?php
/*************************************************************************************/
/* */
/* Thelia */
/* */
/* Copyright (c) OpenStudio */
/* email : info@thelia.net */
/* web : http://www.thelia.net */
/* */
/* This program is free software; you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation; either version 3 of the License */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/*************************************************************************************/
namespace Thelia\Tests\Type;
use Thelia\Type\IntListType;
/**
*
* @author Etienne Roudeix <eroudeix@openstudio.fr>
*
*/
class IntListTypeTest extends \PHPUnit_Framework_TestCase
{
public function testIntListType()
{
$intListType = new IntListType();
$this->assertTrue($intListType->isValid('1'));
$this->assertTrue($intListType->isValid('1,2,3'));
$this->assertFalse($intListType->isValid('1,2,3.3'));
}
}

View File

@@ -0,0 +1,42 @@
<?php
/*************************************************************************************/
/* */
/* Thelia */
/* */
/* Copyright (c) OpenStudio */
/* email : info@thelia.net */
/* web : http://www.thelia.net */
/* */
/* This program is free software; you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation; either version 3 of the License */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/*************************************************************************************/
namespace Thelia\Tests\Type;
use Thelia\Type\IntType;
/**
*
* @author Etienne Roudeix <eroudeix@openstudio.fr>
*
*/
class IntTypeTest extends \PHPUnit_Framework_TestCase
{
public function testIntType()
{
$intType = new IntType();
$this->assertTrue($intType->isValid('1'));
$this->assertTrue($intType->isValid(2));
$this->assertFalse($intType->isValid('3.3'));
}
}

View File

@@ -0,0 +1,41 @@
<?php
/*************************************************************************************/
/* */
/* Thelia */
/* */
/* Copyright (c) OpenStudio */
/* email : info@thelia.net */
/* web : http://www.thelia.net */
/* */
/* This program is free software; you can redistribute it and/or modify */
/* it under the terms of the GNU General Public License as published by */
/* the Free Software Foundation; either version 3 of the License */
/* */
/* This program is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU General Public License for more details. */
/* */
/* You should have received a copy of the GNU General Public License */
/* along with this program. If not, see <http://www.gnu.org/licenses/>. */
/* */
/*************************************************************************************/
namespace Thelia\Tests\Type;
use Thelia\Type\JsonType;
/**
*
* @author Etienne Roudeix <eroudeix@openstudio.fr>
*
*/
class JsonTypeTest extends \PHPUnit_Framework_TestCase
{
public function testJsonType()
{
$jsonType = new JsonType();
$this->assertTrue($jsonType->isValid('{"k0":"v0","k1":"v1","k2":"v2"}'));
$this->assertFalse($jsonType->isValid('1,2,3'));
}
}

View File

@@ -37,18 +37,18 @@ class TypeTest extends \PHPUnit_Framework_TestCase
{
$collection = new TypeCollection(
new Type\AnyType(),
new Type\AnyType()
new Type\IntType()
);
$collection->addType(
new Type\AnyType()
new Type\FloatType()
);
$this->assertAttributeEquals(
array(
new Type\AnyType(),
new Type\AnyType(),
new Type\AnyType(),
new Type\IntType(),
new Type\FloatType(),
),
'types',
$collection
@@ -59,55 +59,18 @@ class TypeTest extends \PHPUnit_Framework_TestCase
{
$collection = new TypeCollection(
new Type\AnyType(),
new Type\AnyType(),
new Type\AnyType()
new Type\IntType(),
new Type\FloatType()
);
$types = \PHPUnit_Framework_Assert::readAttribute($collection, 'types');
$collection->rewind();
while ($collection->valid()) {
$type = $collection->current();
foreach($collection as $key => $type) {
$this->assertEquals(
$type,
$types[$collection->key()]
$types[$key]
);
$collection->next();
}
}
public function testTypes()
{
$anyType = new Type\AnyType();
$this->assertTrue($anyType->isValid(md5(rand(1000, 10000))));
$intType = new Type\IntType();
$this->assertTrue($intType->isValid('1'));
$this->assertTrue($intType->isValid(2));
$this->assertFalse($intType->isValid('3.3'));
$floatType = new Type\FloatType();
$this->assertTrue($floatType->isValid('1.1'));
$this->assertTrue($floatType->isValid(2.2));
$this->assertFalse($floatType->isValid('foo'));
$enumType = new Type\EnumType(array("cat", "dog"));
$this->assertTrue($enumType->isValid('cat'));
$this->assertTrue($enumType->isValid('dog'));
$this->assertFalse($enumType->isValid('monkey'));
$this->assertFalse($enumType->isValid('catdog'));
$intListType = new Type\IntListType();
$this->assertTrue($intListType->isValid('1'));
$this->assertTrue($intListType->isValid('1,2,3'));
$this->assertFalse($intListType->isValid('1,2,3.3'));
$jsonType = new Type\JsonType();
$this->assertTrue($jsonType->isValid('{"k0":"v0","k1":"v1","k2":"v2"}'));
$this->assertFalse($jsonType->isValid('1,2,3'));
}
}

View File

@@ -99,4 +99,61 @@ An image from asset directory :
{/loop}
</div>
<div>
<p>Some pagination</p>
<p>PAGE 1</p>
<ul>
{loop type="category" name="catloopwithpagination1" limit="2" page="1"}
<li>{$__COUNT__}/{$__TOTAL__} : {$ID} {$TITLE}</li>
{/loop}
</ul>
<p>PAGE 2</p>
<ul>
{loop type="category" name="catloopwithpagination2" limit="2" page="2"}
<li>{$__COUNT__}/{$__TOTAL__} : {$ID} {$TITLE}</li>
{/loop}
</ul>
<p>PAGE 1000</p>
<ul>
{loop type="category" name="catloopwithpagination1000" limit="2" page="1000"}
<li>{$__COUNT__}/{$__TOTAL__} : {$ID} {$TITLE}</li>
{/loop}
{elseloop rel="catloopwithpagination1000"}
NO RESULTS
{/elseloop}
</ul>
</div>
<div>
<p>Some pagination with page choice</p>
{assign var=current_page value=2}
<p>PAGE {$current_page} :</p>
<ul>
{loop type="category" name="catloopwithpaginationchoice" limit="2" page="{$current_page}"}
<li>{$__COUNT__}/{$__TOTAL__} : {$ID} {$TITLE}</li>
{/loop}
</ul>
<p>page choice</p>
{pageloop rel="catloopwithpaginationchoice"}
{if ${PAGE} != {$current_page}}
{if {$PAGE} > {$current_page}-10 AND {$PAGE} < {$current_page}+10}
{$PAGE}
{/if}
{if {$PAGE} == {$current_page}-10 OR {$PAGE} == {$current_page}+10}
...
{/if}
{if ({$PAGE} < {$current_page}-10 OR {$PAGE} > {$current_page}+10) AND ({$PAGE}%10 == 0 OR ${PAGE} == {$LAST} OR ${PAGE} == 1)}
{$PAGE}
{/if}
{else}
{ {$PAGE} }
{/if}
{if {$PAGE} != {$LAST}}
-
{/if}
{/pageloop}
</div>
{include file="includes/footer.html"}