euromark 12 年之前
父节点
当前提交
b2b149b1d8

+ 5 - 5
View/Helper/BootstrapHelper.php

@@ -37,7 +37,7 @@ class BootstrapHelper extends AppHelper {
 	 * @param options:
 	 * - data (array of strings)
 	 * - items (defaults to 8)
-	 * @return string $html
+	 * @return string html
 	 * 2012-03-29 ms
 	 */
 	public function typeahead($fieldName, $options = array(), $inputOptions = array()) {
@@ -70,7 +70,7 @@ class BootstrapHelper extends AppHelper {
 	 * @param array $items (heading, content, active)
 	 * @param id
 	 * @param array $options
-	 * @return string $html
+	 * @return string html
 	 * 2012-03-29 ms
 	 */
 	public function carousel($items, $id = null, $globalOptions = array()) {
@@ -94,7 +94,7 @@ class BootstrapHelper extends AppHelper {
 	 *
 	 * @param array $items (heading, content, active)
 	 * - active (visible, true/false)
-	 * @return string $html
+	 * @return string html
 	 * 2012-03-29 ms
 	 */
 	public function carouselItems($items, $options = array()) {
@@ -121,7 +121,7 @@ class BootstrapHelper extends AppHelper {
 	 * @param array $records (heading, content, options)
 	 * @param id
 	 * @param array $options
-	 * @return string $html
+	 * @return string html
 	 * 2012-03-29 ms
 	 */
 	public function accordion($records, $id = null, $globalOptions = array()) {
@@ -142,7 +142,7 @@ class BootstrapHelper extends AppHelper {
 	 * @param string $content
 	 * @param array $options
 	 * - active (collapsed, true/false)
-	 * @return string $html
+	 * @return string html
 	 * 2012-03-29 ms
 	 */
 	public function accordionGroup($heading, $content, $options = array()) {

+ 14 - 14
View/Helper/CommonHelper.php

@@ -41,7 +41,7 @@ class CommonHelper extends AppHelper {
 	 * Convenience function for clean meta name tags
 	 * @param STRING $name: author, date, generator, revisit-after, language
 	 * @param MIXED $content: if array, it will be seperated by commas
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2009-07-07 ms
 	 */
 	public function metaName($name = null, $content = null) {
@@ -60,7 +60,7 @@ class CommonHelper extends AppHelper {
 	 * @param string $content
 	 * @param string $language (iso2: de, en-us, ...)
 	 * @param array $additionalOptions
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 */
 	public function metaDescription($content, $language = null, $options = array()) {
 		if (!empty($language)) {
@@ -77,7 +77,7 @@ class CommonHelper extends AppHelper {
 	 * @param string|array $keywords
 	 * @param string $language (iso2: de, en-us, ...)
 	 * @param boolean $escape
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 */
 	public function metaKeywords($keywords = null, $language = null, $escape = true) {
 		if ($keywords === null) {
@@ -102,7 +102,7 @@ class CommonHelper extends AppHelper {
 	 *
 	 * @param mixed $url
 	 * @param boolean $full
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2010-03-03 ms
 	 */
 	public function metaCanonical($url = null, $full = false) {
@@ -119,7 +119,7 @@ class CommonHelper extends AppHelper {
 	 * - de
 	 * - de-ch
 	 * etc
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2011-12-12 ms
 	 */
 	public function metaAlternate($url, $lang, $full = false) {
@@ -148,7 +148,7 @@ class CommonHelper extends AppHelper {
 	 *
 	 * @param STRING type
 	 * @param STRING content
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2008-12-08 ms
 	 */
 	public function metaRss($url = null, $title = null) {
@@ -169,7 +169,7 @@ class CommonHelper extends AppHelper {
 	 *
 	 * @param STRING type
 	 * @param STRING content
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2008-12-08 ms
 	 */
 	public function metaEquiv($type, $value, $escape = true) {
@@ -190,7 +190,7 @@ class CommonHelper extends AppHelper {
 	 * => x is in webroot/
 	 * => y is in plugins/tools/webroot/
 	 * => z is in plugins/tools/packages/jquery/files/jquery/sub/
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2011-03-23 ms
 	 */
 	public function css($files = array(), $rel = null, $options = array()) {
@@ -211,7 +211,7 @@ class CommonHelper extends AppHelper {
 	 * => x is in webroot/
 	 * => y is in plugins/tools/webroot/
 	 * => z is in plugins/tools/packages/jquery/files/jquery/sub/
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2011-03-23 ms
 	 */
 	public function script($files = array(), $options = array()) {
@@ -231,7 +231,7 @@ class CommonHelper extends AppHelper {
 	 * IN USAGE
 	 * needs manual adjustment, but still better than the core one!
 	 * @example needs Asset.cssversion => xyz (going up with counter)
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2008-12-08 ms
 	 */
 	public function cssDyn($path, $rel = null, $htmlAttributes = array(), $return = true) {
@@ -243,7 +243,7 @@ class CommonHelper extends AppHelper {
 	 * NOT IN USAGE
 	 * but better than the core one!
 	 * @example needs Asset.timestamp => force
-	 * @return string $htmlMarkup
+	 * @return string htmlMarkup
 	 * 2008-12-08 ms
 	 */
 	public function cssAuto($path, $rel = null, $htmlAttributes = array(), $return = true) {
@@ -259,7 +259,7 @@ class CommonHelper extends AppHelper {
 	/**
 	 * still necessary?
 	 * @param array $fields
-	 * @return string $html
+	 * @return string html
 	 */
 	public function displayErrors($fields = array()) {
 		$res = '';
@@ -369,7 +369,7 @@ class CommonHelper extends AppHelper {
 	 * @param string $singular
 	 * @param string $plural
 	 * @param integer $count
-	 * @return string $result
+	 * @return string result
 	 * 2009-07-23 ms
 	 */
 	public function sp($singular, $plural, $count, $autoTranslate = false) {
@@ -471,7 +471,7 @@ class CommonHelper extends AppHelper {
 	 *
 	 * @param string $text
 	 * @param array $options
-	 * @return string $processedText
+	 * @return string processedText
 	 * - nl2br: true/false (defaults to true)
 	 * - escape: false prevents h() and space transformation (defaults to true)
 	 * - tabsToSpaces: int (defaults to 4)

+ 1 - 1
View/Helper/DatetimeHelper.php

@@ -49,7 +49,7 @@ class DatetimeHelper extends TimeHelper {
 
 	/**
 	 * @param string date (from db)
-	 * @return integer $age on success, mixed $default otherwise
+	 * @return integer age on success, mixed $default otherwise
 	 * 2009-11-22 ms
 	 */
 	public function userAge($date = null, $default = '---') {

+ 1 - 1
View/Helper/DiffHelper.php

@@ -64,7 +64,7 @@ class DiffHelper extends AppHelper {
 	 * - div: true/false
 	 * - class: defaults to "diff"
 	 * - escape: defaults to true
-	 * @return string $output
+	 * @return string output
 	 */
 	public function compare($original, $changed, $options = array()) {
 		$original = $this->_prep($original);

+ 1 - 1
View/Helper/FlattrHelper.php

@@ -91,7 +91,7 @@ class FlattrHelper extends AppHelper {
 	 * @param mixed $uid
 	 * @param array $options:
 	 * - tle, cat, lng, dsc, url, btn, tags, hidden (optional)
-	 * @return string $html with js script tag
+	 * @return string html with js script tag
 	 * 2010-12-11 ms
 	 */
 	public function badge($uid = null, $options = array()) {

+ 6 - 6
View/Helper/FormatHelper.php

@@ -246,7 +246,7 @@ class FormatHelper extends TextHelper {
 	 * - normal: display an icon for normal as well (defaults to false)
 	 * - map: array (manually map values, if you use 1 based values no need for that)
 	 * - title, alt, ...
-	 * @return string $html
+	 * @return string html
 	 * 2012-08-02 ms
 	 */
 	public function priorityIcon($value, $options = array()) {
@@ -708,7 +708,7 @@ class FormatHelper extends TextHelper {
 	 * @param array $options (for generation):
 	 * - inline, font, size, background (optional)
 	 * @param array $tagAttributes (for image)
-	 * @return string $result - as image
+	 * @return string result - as image
 	 * 2010-12-13 ms
 	 */
 	public function textAsImage($text, $options = array(), $attr = array()) {
@@ -733,7 +733,7 @@ class FormatHelper extends TextHelper {
 	}
 
 	/**
-	 * @return string $htmlImage tag (or empty string on failure)
+	 * @return string htmlImage tag (or empty string on failure)
 	 * 2010-12-13 ms
 	 */
 	public function _textAsImage($text, $options = array(), $attr = array()) {
@@ -873,7 +873,7 @@ class FormatHelper extends TextHelper {
 	 * @param integer $padLength
 	 * @param string $padString
 	 * @param mixed $padType
-	 * @return string $input
+	 * @return string input
 	 * 2011-09-27 ms
 	 */
 	public function pad($input, $padLength, $padString, $padType = STR_PAD_RIGHT) {
@@ -1035,7 +1035,7 @@ class FormatHelper extends TextHelper {
 	 * @param boolean $full
 	 * @param array $options
 	 * - hash (string)
-	 * @return string $url
+	 * @return string url
 	 * 2011-01-30 ms
 	 */
 	public function profileUrl($uid, $username, $full = false, $options = array()) {
@@ -1200,7 +1200,7 @@ class FormatHelper extends TextHelper {
 	 * @param boolean $ok: true/false (defaults to false)
 	 * //@param string $comparizonType
 	 * //@param mixed $okValue
-	 * @return string $newValue nicely formatted/colored
+	 * @return string newValue nicely formatted/colored
 	 * 2009-08-02 ms
 	 */
 	public function ok($value, $ok = false) {

+ 12 - 12
View/Helper/GoogleMapV3Helper.php

@@ -270,7 +270,7 @@ class GoogleMapV3Helper extends AppHelper {
 	 * @param boolean $sensor
 	 * @param string $language (iso2: en, de, ja, ...)
 	 * @param string $append (more key-value-pairs to append)
-	 * @return string $fullUrl
+	 * @return string fullUrl
 	 * 2009-03-09 ms
 	 */
 	public function apiUrl($sensor = false, $api = null, $language = null, $append = null) {
@@ -306,7 +306,7 @@ class GoogleMapV3Helper extends AppHelper {
 	}
 
 	/**
-	 * @return string $currentMapObject
+	 * @return string currentMapObject
 	 * 2010-12-18 ms
 	 */
 	public function name() {
@@ -314,7 +314,7 @@ class GoogleMapV3Helper extends AppHelper {
 	}
 
 	/**
-	 * @return string $currentContainerId
+	 * @return string currentContainerId
 	 * 2010-12-18 ms
 	 */
 	public function id() {
@@ -389,7 +389,7 @@ class GoogleMapV3Helper extends AppHelper {
 	 * Returns the div container you can echo on the website
 	 *
 	 * @param array $options associative array of settings are passed
-	 * @return string $divContainer
+	 * @return string divContainer
 	 * 2010-12-20 ms
 	 */
 	public function map($options = array()) {
@@ -481,7 +481,7 @@ class GoogleMapV3Helper extends AppHelper {
 	 * @param array $options
 	 * - lat and lng or address (to geocode on demand, not recommended, though)
 	 * - title, content, icon, directions, maxWidth (optional)
-	 * @return integer $markerCount or false on failure
+	 * @return integer markerCount or false on failure
 	 * @throws CakeException
 	 * 2010-12-18 ms
 	 */
@@ -806,7 +806,7 @@ var iconShape = {
 	/**
 	 * @param array $options
 	 * - lat, lng, content, maxWidth, pixelOffset, zIndex
-	 * @return integer $windowCount
+	 * @return integer windowCount
 	 * 2010-12-18 ms
 	 */
 	public function addInfoWindow($options=array()) {
@@ -1142,7 +1142,7 @@ var iconShape = {
 	/**
 	 * auto center map
 	 * careful: with only one marker this can result in too high zoom values!
-	 * @return string $autoCenterCommands
+	 * @return string autoCenterCommands
 	 * 2010-12-17 ms
 	 */
 	protected function _autoCenter() {
@@ -1290,7 +1290,7 @@ var iconShape = {
 	 * - title
 	 * - alt (defaults to 'Map')
 	 * - url (tip: you can pass $this->link(...) and it will create a link to maps.google.com)
-	 * @return string $imageTag
+	 * @return string imageTag
 	 * 2010-12-18 ms
 	 */
 	public function staticMap($options = array(), $attributes = array()) {
@@ -1315,7 +1315,7 @@ var iconShape = {
 	 * Create an url to a plain image map
 	 * @param options
 	 * - see staticMap() for details
-	 * @return string $urlOfImage: http://...
+	 * @return string urlOfImage: http://...
 	 * 2010-12-18 ms
 	 */
 	public function staticMapUrl($options = array()) {
@@ -1434,7 +1434,7 @@ var iconShape = {
 	 * - elements: [required] (multiple array(lat=>x, lng=>y) or just a address strings)
 	 * - color: red/blue/green (optional, default blue)
 	 * - weight: numeric (optional, default: 5)
-	 * @return string $paths: e.g: color:0x0000FF80|weight:5|37.40303,-122.08334|37.39471,-122.07201|37.40589,-122.06171{|...}
+	 * @return string paths: e.g: color:0x0000FF80|weight:5|37.40303,-122.08334|37.39471,-122.07201|37.40589,-122.06171{|...}
 	 * 2010-12-18 ms
 	 */
 	public function staticPaths($pos = array()) {
@@ -1491,7 +1491,7 @@ var iconShape = {
 	 * - label
 	 * - icon
 	 * - shadow
-	 * @return array $markers: color:green|label:Z|48,11|Berlin
+	 * @return array markers: color:green|label:Z|48,11|Berlin
 	 *
 	 * NEW: size:mid|color:red|label:E|37.400465,-122.073003|37.437328,-122.159928&markers=size:small|color:blue|37.369110,-122.096034
 	 * OLD: 40.702147,-74.015794,blueS|40.711614,-74.012318,greenG{|...}
@@ -1579,7 +1579,7 @@ var iconShape = {
 	 * # to 0x
 	 * or # added
 	 * @param string $color: FFFFFF, #FFFFFF, 0xFFFFFF or blue
-	 * @return string $color
+	 * @return string color
 	 * 2010-12-20 ms
 	 */
 	protected function _prepColor($color) {

+ 1 - 1
View/Helper/MyHelper.php

@@ -76,7 +76,7 @@ class MyHelper extends Helper {
 	 * enhancement for HtmlHelper
 	 * @param binary $content
 	 * @param array $options
-	 * @return string $html imageTag
+	 * @return string html imageTag
 	 * 2010-11-22 ms
 	 */
 	public function imageFromBlob($content, $options = array()) {

+ 1 - 1
View/Helper/PhpThumbHelper.php

@@ -154,7 +154,7 @@ class PhpThumbHelper extends AppHelper {
 	}
 
 	/**
-	 * @return string $error
+	 * @return string error
 	 * 2010-05-15 ms
 	 */
 	public function error() {

+ 3 - 3
View/Helper/QrCodeHelper.php

@@ -109,7 +109,7 @@ class QrCodeHelper extends AppHelper {
 	/**
 	 * format a text in a specific format
 	 * - url, sms, tel, email, market, geo
-	 * @return string $formattedText
+	 * @return string formattedText
 	 * 2010-02-06 ms
 	 */
 	public function formatText($text, $type = null) {
@@ -144,7 +144,7 @@ class QrCodeHelper extends AppHelper {
 	 * for details on cards see:
 	 * http://www.nttdocomo.co.jp/english/service/imode/make/content/barcode/function/application/addressbook/index.html
 	 * example: MECARD: N:Docomo,Taro; SOUND:docomotaro; TEL:03XXXXXXXX; EMAIL:d@e.de;
-	 * @return string $mecard
+	 * @return string mecard
 	 * 2010-02-26 ms
 	 */
 	public function formatCard($data) {
@@ -309,7 +309,7 @@ class QrCodeHelper extends AppHelper {
 	 * ...
 	 * 4000 => 547x547 (L)
 	 * @param integer $length
-	 * @return integer $size
+	 * @return integer size
 	 * 2011-06-06 ms
 	 */
 	protected function _findSuitableSize() {

+ 9 - 9
View/Helper/TextExtHelper.php

@@ -73,7 +73,7 @@ class TextExtHelper extends TextHelper {
 	 * - obfuscate: true/false (defaults to false)
 	 * @param array $options
 	 * - escape (defaults to true)
-	 * @return string $html
+	 * @return string html
 	 * @override
 	 * 2010-11-20 ms
 	 */
@@ -105,7 +105,7 @@ class TextExtHelper extends TextHelper {
 	 * @param string $email
 	 * @param options:
 	 * - obfuscate: true/false (defaults to false)
-	 * @return string $html
+	 * @return string html
 	 * 2010-11-20 ms
 	 */
 	public static function prepareEmail($email, $options = array(), $customOptions = array()) {
@@ -137,7 +137,7 @@ class TextExtHelper extends TextHelper {
 	 * each part of this mail now does not make sense anymore on its own
 	 * (striptags will not work either)
 	 * @param string email: necessary (and valid - containing one @)
-	 * @return string $html
+	 * @return string html
 	 * 2009-03-11 ms
 	 */
 	public function encodeEmail($mail) {
@@ -152,7 +152,7 @@ class TextExtHelper extends TextHelper {
 	 * @param string text: optional (if none is given, email will be text as well)
 	 * @param array attributes: html tag attributes
 	 * @param array params: ?subject=y&body=y to be attached to "mailto:xyz"
-	 * @return string $html with js generated link around email (and non js fallback)
+	 * @return string html with js generated link around email (and non js fallback)
 	 * 2009-04-20 ms
 	 */
 	public function encodeEmailUrl($mail, $text=null, $params=array(), $attr = array()) {
@@ -210,7 +210,7 @@ class TextExtHelper extends TextHelper {
 	/**
 	 * Encodes Piece of Text (without usage of JS!) to avoid lowlevel spam bots to get it
 	 * @param STRING text to encode
-	 * @return string $html (randomly encoded)
+	 * @return string html (randomly encoded)
 	 * 2009-03-11 ms
 	 */
 	public static function encodeText($text) {
@@ -240,7 +240,7 @@ class TextExtHelper extends TextHelper {
 	 * - maxLength: int (defaults no none)
 	 * @param htmlOptions
 	 * - escape etc
-	 * @return string $html
+	 * @return string html
 	 * @override
 	 * 2010-11-07 ms
 	 */
@@ -273,7 +273,7 @@ class TextExtHelper extends TextHelper {
 	 * - stripProtocol: bool (defaults to true)
 	 * - maxLength: int (defaults to 50)
 	 * - escape (defaults to false, true needed for hellip to work)
-	 * @return string $html/$plain
+	 * @return string html/$plain
 	 * 2010-11-07 ms
 	 */
 	public static function prepareLinkName($link, $options = array()) {
@@ -301,7 +301,7 @@ class TextExtHelper extends TextHelper {
 	 * Remove http:// or other protocols from the link
 	 *
 	 * @param string $url
-	 * @return string $strippedUrl
+	 * @return string strippedUrl
 	 * 2010-11-07 ms
 	 */
 	public static function stripProtocol($url) {
@@ -354,7 +354,7 @@ class TextExtHelper extends TextHelper {
 	 * Transforming int values into ordinal numbers (1st, 3rd, etc.)
 	 * @param $num (INT) - the number to be suffixed.
 	 * @param $sup (BOOL) - whether to wrap the suffix in a superscript (<sup>) tag on output.
-	 * @return string $ordinal
+	 * @return string ordinal
 	 */
 	public static function ordinalNumber($num = 0, $sup = false) {
 		$suff = '';