Deprecate old string usage.

Test/Case/View/Helper/FormatHelperTest.php

@@ -17,6 +17,8 @@ class FormatHelperTest extends MyCakeTestCase {
 	public function setUp() {
 		parent::setUp();
 
+		Configure::delete('Format');
+
 		$this->Format = new FormatHelper(new View(null));
 		$this->Format->Html = new HtmlExtHelper(new View(null));
 	}
@@ -159,7 +161,11 @@ class FormatHelperTest extends MyCakeTestCase {
 		$this->assertTextContains($expected, $result);
 
 		$result = $this->Format->yesNo(false);
-		$expected = '<img src="/img/icons/no.gif" title="' . __d('tools', 'No') . '" alt=';
+		$expected = '<img src="/img/icons/no.png" title="' . __d('tools', 'No') . '" alt=';
+		$this->assertTextContains($expected, $result);
+
+		$result = $this->Format->yesNo(true, ['on' => 1, 'onTitle' => 'foo']);
+		$expected = '<img src="/img/icons/yes.gif" title="foo" alt=';
 		$this->assertTextContains($expected, $result);
 
 		$this->Format->settings['fontIcons'] = [
@@ -378,27 +384,20 @@ class FormatHelperTest extends MyCakeTestCase {
 	 * @return void
 	 */
 	public function testNeighbors() {
-		if (!defined('ICON_PREV')) {
-			define('ICON_PREV', 'prev');
-		}
-		if (!defined('ICON_NEXT')) {
-			define('ICON_NEXT', 'next');
-		}
-
 		$neighbors = [
 			'prev' => ['ModelName' => ['id' => 1, 'foo' => 'bar']],
 			'next' => ['ModelName' => ['id' => 2, 'foo' => 'y']],
 		];
 		$result = $this->Format->neighbors($neighbors, 'foo');
-		$expected = '<div class="next-prev-navi nextPrevNavi"><a href="/index/1" title="bar"><img src="/img/icons/prev" alt="[]" class="icon"/>&nbsp;prevRecord</a>&nbsp;&nbsp;<a href="/index/2" title="y"><img src="/img/icons/next" alt="[]" class="icon"/>&nbsp;nextRecord</a></div>';
+		$expected = '<div class="next-prev-navi nextPrevNavi"><a href="/index/1" title="bar"><img src="/img/icons/nav_back.png" alt="[]" class="icon"/>&nbsp;prevRecord</a>&nbsp;&nbsp;<a href="/index/2" title="y"><img src="/img/icons/nav_forward.png" alt="[]" class="icon"/>&nbsp;nextRecord</a></div>';
 
 		$this->assertEquals($expected, $result);
 
 		$this->Format->settings['fontIcons'] = [
-			'prev' => 'fa fa-prev',
-			'next' => 'fa fa-next'];
+			'nav_back' => 'fa fa-prev',
+			'nav_forward' => 'fa fa-next'];
 		$result = $this->Format->neighbors($neighbors, 'foo');
-		$expected = '<div class="next-prev-navi nextPrevNavi"><a href="/index/1" title="bar"><i class="fa fa-prev prev" title="" data-placement="bottom" data-toggle="tooltip"></i>&nbsp;prevRecord</a>&nbsp;&nbsp;<a href="/index/2" title="y"><i class="fa fa-next next" title="" data-placement="bottom" data-toggle="tooltip"></i>&nbsp;nextRecord</a></div>';
+		$expected = '<div class="next-prev-navi nextPrevNavi"><a href="/index/1" title="bar"><i class="fa fa-prev nav_back" title="" data-placement="bottom" data-toggle="tooltip"></i>&nbsp;prevRecord</a>&nbsp;&nbsp;<a href="/index/2" title="y"><i class="fa fa-next nav_forward" title="" data-placement="bottom" data-toggle="tooltip"></i>&nbsp;nextRecord</a></div>';
 		$this->assertEquals($expected, $result);
 	}
 

View/Helper/FormatHelper.php

@@ -141,9 +141,9 @@ class FormatHelper extends TextHelper {
 				$url += $options['url'];
 			}
 
-			$ret .= $this->Html->link($this->cIcon(ICON_PREV, false) . ' ' . __d('tools', 'prev' . $name), $url, ['escape' => false, 'title' => $neighbors['prev'][$titleAlias][$titleField]]);
+			$ret .= $this->Html->link($this->cIcon(ICON_PREV, ['title' => false]) . ' ' . __d('tools', 'prev' . $name), $url, ['escape' => false, 'title' => $neighbors['prev'][$titleAlias][$titleField]]);
 		} else {
-			$ret .= $this->cIcon(ICON_PREV_DISABLED, __d('tools', 'noPrev' . $name)) . ' ' . __d('tools', 'prev' . $name);
+			$ret .= $this->cIcon(ICON_PREV_DISABLED, ['title' => __d('tools', 'noPrev' . $name)]) . ' ' . __d('tools', 'prev' . $name);
 		}
 		$ret .= '  ';
 		if (!empty($neighbors['next'])) {
@@ -152,9 +152,9 @@ class FormatHelper extends TextHelper {
 				$url += $options['url'];
 			}
 
-			$ret .= $this->Html->link($this->cIcon(ICON_NEXT, false) . ' ' . __d('tools', 'next' . $name), $url, ['escape' => false, 'title' => $neighbors['next'][$titleAlias][$titleField]]);
+			$ret .= $this->Html->link($this->cIcon(ICON_NEXT, ['title' => false]) . ' ' . __d('tools', 'next' . $name), $url, ['escape' => false, 'title' => $neighbors['next'][$titleAlias][$titleField]]);
 		} else {
-			$ret .= $this->cIcon(ICON_NEXT_DISABLED, __d('tools', 'noNext' . $name)) . ' ' . __d('tools', 'next' . $name);
+			$ret .= $this->cIcon(ICON_NEXT_DISABLED, ['title' => __d('tools', 'noNext' . $name)]) . ' ' . __d('tools', 'next' . $name);
 		}
 		$ret .= '</div>';
 		return $ret;
@@ -682,19 +682,46 @@ class FormatHelper extends TextHelper {
 	/**
 	 * Display yes/no symbol.
 	 *
-	 * @todo $on=1, $text=false, $ontitle=false,... => in array(OPTIONS)
+	 * Params $on, $text are deprecated
 	 *
-	 * @param text: default FALSE; if TRUE, text instead of the image
-	 * @param ontitle: default FALSE; if it is embadded in a link, set to TRUE
-	 * @return image:Yes/No or text:Yes/No
+	 * @param int|bool $value Value
+	 * @param array $options
+	 * - on (defaults to 1/true)
+	 * - onTitle
+	 * - offTitle
+	 * @param array $attributes
+	 * - title, ...
+	 * @return string HTML icon Yes/No
 	 */
-	public function yesNo($v, $ontitle = null, $offtitle = null, $on = 1, $text = false, $notitle = false) {
-		$ontitle = (!empty($ontitle) ? $ontitle : __d('tools', 'Yes'));
-		$offtitle = (!empty($offtitle) ? $offtitle : __d('tools', 'No'));
-		$sbez = ['0' => @substr($offtitle, 0, 1), '1' => @substr($ontitle, 0, 1)];
-		$bez = ['0' => $offtitle, '1' => $ontitle];
+	public function yesNo($value, $options = [], $attributes = [], $on = 1, $text = false) {
+		$defaults = [
+			'on' => 1,
+			'onTitle' => __d('tools', 'Yes'),
+			'offTitle' => __d('tools', 'No'),
+			'text' => false
+		];
+
+		if (!is_array($options)) {
+			$onTitle = $options ?: null;
+			$options = [
+				'on' => $on,
+				'text' => $text,
+			];
+			if ($onTitle) {
+				$options['onTitle'] = $onTitle;
+			}
+			trigger_error('Deprecated, use array syntax', E_USER_DEPRECATED);
+		}
+		if (!is_array($attributes)) {
+			$options['offTitle'] = $attributes;
+		}
 
-		if ($v == $on) {
+		$options += $defaults;
+
+		$sbez = ['0' => @substr($options['offTitle'], 0, 1), '1' => @substr($options['onTitle'], 0, 1)];
+		$bez = ['0' => $options['offTitle'], '1' => $options['onTitle']];
+
+		if ($value == $options['on']) {
 			$icon = ICON_YES;
 			$value = 1;
 		} else {
@@ -702,14 +729,14 @@ class FormatHelper extends TextHelper {
 			$value = 0;
 		}
 
-		if ($text !== false) {
+		if ($options['text'] !== false) {
 			return $bez[$value];
 		}
 
-		$options = ['title' => ($ontitle === false ? '' : $bez[$value]), 'alt' => $sbez[$value], 'class' => 'icon'];
+		$options = ['title' => ($options['onTitle'] === false ? '' : $bez[$value]), 'alt' => $sbez[$value], 'class' => 'icon'];
 
 		if ($this->settings['fontIcons']) {
-			return $this->cIcon($icon, $options['title']);
+			return $this->cIcon($icon, ['title' => $options['title']]);
 		}
 		return $this->Html->image('icons/' . $icon, $options);
 	}
@@ -752,15 +779,15 @@ class FormatHelper extends TextHelper {
 
 	/**
 	 * Display text as image
-	 * //TODO: move to own helper
 	 *
 	 * @param string $text
 	 * @param array $options (for generation):
 	 * - inline, font, size, background (optional)
 	 * @param array $tagAttributes (for image)
 	 * @return string result - as image
+	 * @deprecated Must be a different helper in the future
 	 */
-	public function textAsImage($text, $options = [], $attr = []) {
+	public function textAsImage($text, $options = [], $tagAttributes = []) {
 		/*
 		$image = new Imagick();
 		//$image->newImage(218, 46, new ImagickPixel('white'));
@@ -777,12 +804,16 @@ class FormatHelper extends TextHelper {
 		$image->trim($mw,0);
 		*/
 		$defaults = ['alt' => $text];
-		$attr += $defaults;
-		return $this->_textAsImage($text, $options, $attr);
+		$tagAttributes += $defaults;
+		return $this->_textAsImage($text, $options, $tagAttributes);
 	}
 
 	/**
+	 * @param string $text
+	 * @param array $options
+	 * @param array $attr
 	 * @return string htmlImage tag (or empty string on failure)
+	 * @deprecated Must be a different helper in the future
 	 */
 	public function _textAsImage($text, $options = [], $attr = []) {
 		$defaults = ['inline' => true, 'font' => FILES . 'linotype.ttf', 'size' => 18, 'color' => '#7A7166'];
@@ -864,8 +895,8 @@ class FormatHelper extends TextHelper {
 	}
 
 	/**
-	 * @param float progress
-	 * @param array options:
+	 * @param float $progress
+	 * @param array $options:
 	 * - min, max
 	 * - steps
 	 * - decimals (how precise should the result be displayed)
@@ -1501,3 +1532,15 @@ if (!defined('ICON_WARNING')) {
 if (!defined('ICON_MAP')) {
 	define('ICON_MAP', 'map.gif');
 }
+if (!defined('ICON_PREV')) {
+	define('ICON_PREV', 'prev.png');
+}
+if (!defined('ICON_NEXT')) {
+	define('ICON_NEXT', 'next.png');
+}
+if (!defined('ICON_NEXT_DISABLED')) {
+	define('ICON_NEXT_DISABLED', 'nav_forward_grey.png');
+}
+if (!defined('ICON_PREV_DISABLED')) {
+	define('ICON_PREV_DISABLED', 'nav_back_grey.png');
+}