tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

deprecate First and Last in order to disambiguate for array lists

Browse Source
This commit is contained in:
Andrew Aitken-Fincham 2020-06-11 23:45:42 +01:00
parent 1d6a6247a3
commit bac826bc06
1 changed files with 30 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/View/SSViewer_BasicIteratorSupport.php
View File

@ -2,6 +2,8 @@
namespace SilverStripe\View; namespace SilverStripe\View;
use SilverStripe\Dev\Deprecation;
/** /**
* Defines an extra set of basic methods that can be used in templates * Defines an extra set of basic methods that can be used in templates
* that are not defined on sub-classes of {@link ViewableData}. * that are not defined on sub-classes of {@link ViewableData}.
@ -24,6 +26,8 @@ class SSViewer_BasicIteratorSupport implements TemplateIteratorProvider
public static function get_template_iterator_variables() public static function get_template_iterator_variables()
{ {
return [ return [
'isFirst',
'isLast',
'First', 'First',
'Last', 'Last',
'FirstLast', 'FirstLast',
@ -57,21 +61,41 @@ class SSViewer_BasicIteratorSupport implements TemplateIteratorProvider
* *
* @return bool * @return bool
*/ */
public function First() public function isFirst()
{ {
return $this->iteratorPos == 0; return $this->iteratorPos == 0;
} }
/**
* @deprecated
* @return bool
*/
public function First()
{
Deprecation::notice("5.0.0 please use isFirst() to avoid clashes with SS_Lists");
return $this->isFirst();
}
/** /**
* Returns true if this object is the last in a set. * Returns true if this object is the last in a set.
* *
* @return bool * @return bool
*/ */
public function Last() public function isLast()
{ {
return $this->iteratorPos == $this->iteratorTotalItems - 1; return $this->iteratorPos == $this->iteratorTotalItems - 1;
} }
/**
* @deprecated
* @return bool
*/
public function Last()
{
Deprecation::notice("5.0.0 please use isLast() to avoid clashes with SS_Lists");
return $this->isLast();
}
/** /**
* Returns 'first' or 'last' if this is the first or last object in the set. * Returns 'first' or 'last' if this is the first or last object in the set.
* *
@ -79,13 +103,13 @@ class SSViewer_BasicIteratorSupport implements TemplateIteratorProvider
*/ */
public function FirstLast() public function FirstLast()
{ {
if ($this->First() && $this->Last()) { if ($this->isFirst() && $this->isLast()) {
return 'first last'; return 'first last';
} }
if ($this->First()) { if ($this->isFirst()) {
return 'first'; return 'first';
} }
if ($this->Last()) { if ($this->isLast()) {
return 'last'; return 'last';
} }
return null; return null;
@ -98,7 +122,7 @@ class SSViewer_BasicIteratorSupport implements TemplateIteratorProvider
*/ */
public function Middle() public function Middle()
{ {
return !$this->First() && !$this->Last(); return !$this->isFirst() && !$this->isLast();
} }
/** /**