Browse files

fixed phpdoc @param alignment

  • Loading branch information...
1 parent ea4691b commit cba1552452185a6b2e17e650e1903298eb01fa8c @fabpot fabpot committed May 15, 2012
View
4 Exception/MethodArgumentNotImplementedException.php
@@ -21,8 +21,8 @@ class MethodArgumentNotImplementedException extends NotImplementedException
/**
* Constructor
*
- * @param string $methodName The method name that raised the exception
- * @param string $argName The argument name that is not implemented
+ * @param string $methodName The method name that raised the exception
+ * @param string $argName The argument name that is not implemented
*/
public function __construct($methodName, $argName)
{
View
8 Exception/MethodArgumentValueNotImplementedException.php
@@ -21,10 +21,10 @@ class MethodArgumentValueNotImplementedException extends NotImplementedException
/**
* Constructor
*
- * @param string $methodName The method name that raised the exception
- * @param string $argName The argument name
- * @param string $argValue The argument value that is not implemented
- * @param string $additionalMessage An optional additional message to append to the exception message
+ * @param string $methodName The method name that raised the exception
+ * @param string $argName The argument name
+ * @param string $argValue The argument value that is not implemented
+ * @param string $additionalMessage An optional additional message to append to the exception message
*/
public function __construct($methodName, $argName, $argValue, $additionalMessage = '')
{
View
2 Exception/NotImplementedException.php
@@ -23,7 +23,7 @@ class NotImplementedException extends \RuntimeException
/**
* Constructor
*
- * @param string $message The exception message. A note to install the intl extension is appended to this string
+ * @param string $message The exception message. A note to install the intl extension is appended to this string
*/
public function __construct($message)
{
View
6 Locale.php
@@ -34,7 +34,7 @@ class Locale extends \Locale
/**
* Returns the country names for a locale
*
- * @param string $locale The locale to use for the country names
+ * @param string $locale The locale to use for the country names
*
* @return array The country names with their codes as keys
*
@@ -89,7 +89,7 @@ static public function getCountries()
/**
* Returns the language names for a locale
*
- * @param string $locale The locale to use for the language names
+ * @param string $locale The locale to use for the language names
*
* @return array The language names with their codes as keys
*
@@ -142,7 +142,7 @@ static public function getLanguages()
/**
* Returns the locale names for a locale
*
- * @param string $locale The locale to use for the locale names
+ * @param string $locale The locale to use for the locale names
* @return array The locale names with their codes as keys
* @throws RuntimeException When the resource bundles cannot be loaded
*/
View
26 Stub/DateFormat/FullTransformer.php
@@ -34,8 +34,8 @@ class FullTransformer
/**
* Constructor
*
- * @param string $pattern The pattern to be used to format and/or parse values
- * @param string $timezone The timezone to perform the date/time calculations
+ * @param string $pattern The pattern to be used to format and/or parse values
+ * @param string $timezone The timezone to perform the date/time calculations
*/
public function __construct($pattern, $timezone)
{
@@ -79,7 +79,7 @@ public function getTransformers()
/**
* Format a DateTime using ICU dateformat pattern
*
- * @param DateTime $dateTime A DateTime object to be used to generate the formatted value
+ * @param DateTime $dateTime A DateTime object to be used to generate the formatted value
*
* @return string The formatted value
*/
@@ -97,8 +97,8 @@ public function format(\DateTime $dateTime)
/**
* Return the formatted ICU value for the matched date characters
*
- * @param string $dateChars The date characters to be replaced with a formatted ICU value
- * @param DateTime $dateTime A DateTime object to be used to generate the formatted value
+ * @param string $dateChars The date characters to be replaced with a formatted ICU value
+ * @param DateTime $dateTime A DateTime object to be used to generate the formatted value
*
* @return string The formatted value
*
@@ -127,8 +127,8 @@ public function formatReplace($dateChars, $dateTime)
/**
* Parse a pattern based string to a timestamp value
*
- * @param DateTime $dateTime A configured DateTime object to use to perform the date calculation
- * @param string $value String to convert to a time value
+ * @param DateTime $dateTime A configured DateTime object to use to perform the date calculation
+ * @param string $value String to convert to a time value
*
* @return int The corresponding Unix timestamp
*
@@ -163,7 +163,7 @@ public function parse(\DateTime $dateTime, $value)
/**
* Retrieve a regular expression to match with a formatted value.
*
- * @param string $pattern The pattern to create the reverse matching regular expression
+ * @param string $pattern The pattern to create the reverse matching regular expression
*
* @return string The reverse matching regular expression with named captures being formed by the
* transformer index in the $transformer array
@@ -198,7 +198,7 @@ public function getReverseMatchingRegExp($pattern)
/**
* Check if the first char of a string is a single quote
*
- * @param string $quoteMatch The string to check
+ * @param string $quoteMatch The string to check
*
* @return Boolean true if matches, false otherwise
*/
@@ -210,7 +210,7 @@ public function isQuoteMatch($quoteMatch)
/**
* Replaces single quotes at the start or end of a string with two single quotes
*
- * @param string $quoteMatch The string to replace the quotes
+ * @param string $quoteMatch The string to replace the quotes
*
* @return string A string with the single quotes replaced
*/
@@ -226,7 +226,7 @@ public function replaceQuoteMatch($quoteMatch)
/**
* Builds a chars match regular expression
*
- * @param string $specialChars A string of chars to build the regular expression
+ * @param string $specialChars A string of chars to build the regular expression
*
* @return string The chars match regular expression
*/
@@ -271,8 +271,8 @@ protected function normalizeArray(array $data)
* Calculates the Unix timestamp based on the matched values by the reverse matching regular
* expression of parse()
*
- * @param DateTime $dateTime The DateTime object to be used to calculate the timestamp
- * @param array $options An array with the matched values to be used to calculate the timestamp
+ * @param DateTime $dateTime The DateTime object to be used to calculate the timestamp
+ * @param array $options An array with the matched values to be used to calculate the timestamp
*
* @return Boolean|int The calculated timestamp or false if matched date is invalid
*/
View
4 Stub/DateFormat/HourTransformer.php
@@ -21,8 +21,8 @@
/**
* Returns a normalized hour value suitable for the hour transformer type
*
- * @param int $hour The hour value
- * @param string $marker An optional AM/PM marker
+ * @param int $hour The hour value
+ * @param string $marker An optional AM/PM marker
*
* @return int The normalized hour value
*/
View
2 Stub/DateFormat/TimeZoneTransformer.php
@@ -64,7 +64,7 @@ public function extractDateOptions($matched, $length)
* Only GMT, Etc/Universal, Etc/Zulu, Etc/Greenwich, Etc/GMT-0, Etc/GMT+0 and Etc/GMT0 are old names and
* are linked to Etc/GMT or Etc/UTC.
*
- * @param string $formattedTimeZone A GMT timezone string (GMT-03:00, e.g.)
+ * @param string $formattedTimeZone A GMT timezone string (GMT-03:00, e.g.)
*
* @return string A timezone identifier
*
View
14 Stub/DateFormat/Transformer.php
@@ -22,8 +22,8 @@
* Format a value using a configured DateTime as date/time source
*
*
- * @param DateTime $dateTime A DateTime object to be used to generate the formatted value
- * @param int $length The formatted value string length
+ * @param DateTime $dateTime A DateTime object to be used to generate the formatted value
+ * @param int $length The formatted value string length
*
* @return string The formatted value
*/
@@ -32,7 +32,7 @@
/**
* Returns a reverse matching regular expression of a string generated by format()
*
- * @param int $length The length of the value to be reverse matched
+ * @param int $length The length of the value to be reverse matched
*
* @return string The reverse matching regular expression
*/
@@ -42,8 +42,8 @@
* Extract date options from a matched value returned by the processing of the reverse matching
* regular expression
*
- * @param string $matched The matched value
- * @param int $length The length of the Transformer pattern string
+ * @param string $matched The matched value
+ * @param int $length The length of the Transformer pattern string
*
* @return array An associative array
*/
@@ -52,8 +52,8 @@
/**
* Pad a string with zeros to the left
*
- * @param string $value The string to be padded
- * @param int $length The length to pad
+ * @param string $value The string to be padded
+ * @param int $length The length to pad
*
* @return string The padded string
*/
View
24 Stub/StubCollator.php
@@ -58,7 +58,7 @@ class StubCollator
/**
* Constructor
*
- * @param string $locale The locale code
+ * @param string $locale The locale code
*
* @throws MethodArgumentValueNotImplementedException When $locale different than 'en' is passed
*/
@@ -72,7 +72,7 @@ public function __construct($locale)
/**
* Static constructor
*
- * @param string $locale The locale code
+ * @param string $locale The locale code
*
* @throws MethodArgumentValueNotImplementedException When $locale different than 'en' is passed
*/
@@ -85,7 +85,7 @@ static public function create($locale)
* Sort array maintaining index association
*
* @param array &$array Input array
- * @param array $sortFlag Flags for sorting, can be one of the following:
+ * @param array $sortFlag Flags for sorting, can be one of the following:
* StubCollator::SORT_REGULAR - compare items normally (don't change types)
* StubCollator::SORT_NUMERIC - compare items numerically
* StubCollator::SORT_STRING - compare items as strings
@@ -108,8 +108,8 @@ public function asort(&$array, $sortFlag = self::SORT_REGULAR)
/**
* Compare two Unicode strings
*
- * @param string $str1 The first string to compare
- * @param string $str2 The second string to compare
+ * @param string $str1 The first string to compare
+ * @param string $str2 The second string to compare
*
* @return Boolean|int Return the comparison result or false on failure:
* 1 if $str1 is greater than $str2
@@ -128,7 +128,7 @@ public function compare($str1, $str2)
/**
* Get a value of an integer collator attribute
*
- * @param int $attr An attribute specifier, one of the attribute constants
+ * @param int $attr An attribute specifier, one of the attribute constants
*
* @return Boolean|int The attribute value on success or false on error
*
@@ -164,7 +164,7 @@ public function getErrorMessage()
/**
* Returns the collator's locale
*
- * @param int $type The locale name type to return between valid or actual (StubLocale::VALID_LOCALE or StubLocale::ACTUAL_LOCALE, respectively)
+ * @param int $type The locale name type to return between valid or actual (StubLocale::VALID_LOCALE or StubLocale::ACTUAL_LOCALE, respectively)
*
* @return string The locale name used to create the collator
*/
@@ -176,7 +176,7 @@ public function getLocale($type = StubLocale::ACTUAL_LOCALE)
/**
* Get sorting key for a string
*
- * @param string $string The string to produce the key from
+ * @param string $string The string to produce the key from
*
* @return string The collation key for $string
*
@@ -206,8 +206,8 @@ public function getStrength()
/**
* Set a collator's attribute
*
- * @param int $attr An attribute specifier, one of the attribute constants
- * @param int $val The attribute value, one of the attribute value constants
+ * @param int $attr An attribute specifier, one of the attribute constants
+ * @param int $val The attribute value, one of the attribute value constants
*
* @return Boolean True on success or false on failure
*
@@ -223,7 +223,7 @@ public function setAttribute($attr, $val)
/**
* Set the collator's strength
*
- * @param int $strength Strength to set, possible values:
+ * @param int $strength Strength to set, possible values:
* StubCollator::PRIMARY
* StubCollator::SECONDARY
* StubCollator::TERTIARY
@@ -262,7 +262,7 @@ public function sortWithSortKeys(&$arr)
* Sort array using specified collator
*
* @param array &$arr Array of string to sort
- * @param int $sortFlag Optional sorting type, one of the following:
+ * @param int $sortFlag Optional sorting type, one of the following:
* StubCollator::SORT_REGULAR
* StubCollator::SORT_NUMERIC
* StubCollator::SORT_STRING
View
6 Stub/StubIntl.php
@@ -67,7 +67,7 @@
/**
* Returns whether the error code indicates a failure
*
- * @param integer $errorCode The error code returned by StubIntl::getErrorCode()
+ * @param integer $errorCode The error code returned by StubIntl::getErrorCode()
*
* @return Boolean
*/
@@ -118,8 +118,8 @@ static public function getErrorName($code)
/**
* Sets the current error
*
- * @param integer $code One of the error constants in this class
- * @param string $message The ICU class error message
+ * @param integer $code One of the error constants in this class
+ * @param string $message The ICU class error message
*
* @throws \InvalidArgumentException If the code is not one of the error constants in this class
*/
View
44 Stub/StubIntlDateFormatter.php
@@ -108,13 +108,13 @@ class StubIntlDateFormatter
/**
* Constructor
*
- * @param string $locale The locale code
- * @param int $datetype Type of date formatting, one of the format type constants
- * @param int $timetype Type of time formatting, one of the format type constants
- * @param string $timezone Timezone identifier
- * @param int $calendar Calendar to use for formatting or parsing; default is Gregorian.
+ * @param string $locale The locale code
+ * @param int $datetype Type of date formatting, one of the format type constants
+ * @param int $timetype Type of time formatting, one of the format type constants
+ * @param string $timezone Timezone identifier
+ * @param int $calendar Calendar to use for formatting or parsing; default is Gregorian.
* One of the calendar constants.
- * @param string $pattern Optional pattern to use when formatting
+ * @param string $pattern Optional pattern to use when formatting
*
* @see http://www.php.net/manual/en/intldateformatter.create.php
* @see http://userguide.icu-project.org/formatparse/datetime
@@ -142,13 +142,13 @@ public function __construct($locale, $datetype, $timetype, $timezone = null, $ca
/**
* Static constructor
*
- * @param string $locale The locale code
- * @param int $datetype Type of date formatting, one of the format type constants
- * @param int $timetype Type of time formatting, one of the format type constants
- * @param string $timezone Timezone identifier
- * @param int $calendar Calendar to use for formatting or parsing; default is Gregorian.
+ * @param string $locale The locale code
+ * @param int $datetype Type of date formatting, one of the format type constants
+ * @param int $timetype Type of time formatting, one of the format type constants
+ * @param string $timezone Timezone identifier
+ * @param int $calendar Calendar to use for formatting or parsing; default is Gregorian.
* One of the calendar constants.
- * @param string $pattern Optional pattern to use when formatting
+ * @param string $pattern Optional pattern to use when formatting
*
* @see http://www.php.net/manual/en/intldateformatter.create.php
* @see http://userguide.icu-project.org/formatparse/datetime
@@ -163,7 +163,7 @@ static public function create($locale, $datetype, $timetype, $timezone = null, $
/**
* Format the date/time value (timestamp) as a string
*
- * @param mixed $timestamp Unix timestamp to format
+ * @param mixed $timestamp Unix timestamp to format
*
* @return string The formatted value
*
@@ -265,7 +265,7 @@ public function getErrorMessage()
/**
* Returns the formatter's locale
*
- * @param int $type The locale name type to return between valid or actual (StubLocale::VALID_LOCALE or StubLocale::ACTUAL_LOCALE, respectively)
+ * @param int $type The locale name type to return between valid or actual (StubLocale::VALID_LOCALE or StubLocale::ACTUAL_LOCALE, respectively)
*
* @return string The locale name used to create the formatter
*
@@ -333,8 +333,8 @@ public function isLenient()
/**
* Parse string to a field-based time value
*
- * @param string $value String to convert to a time value
- * @param int $position Position at which to start the parsing in $value (zero-based).
+ * @param string $value String to convert to a time value
+ * @param int $position Position at which to start the parsing in $value (zero-based).
* If no error occurs before $value is consumed, $parse_pos will
* contain -1 otherwise it will contain the position at which parsing
* ended. If $parse_pos > strlen($value), the parse fails immediately.
@@ -353,8 +353,8 @@ public function localtime($value, &$position = 0)
/**
* Parse string to a timestamp value
*
- * @param string $value String to convert to a time value
- * @param int $position Position at which to start the parsing in $value (zero-based).
+ * @param string $value String to convert to a time value
+ * @param int $position Position at which to start the parsing in $value (zero-based).
* If no error occurs before $value is consumed, $parse_pos will
* contain -1 otherwise it will contain the position at which parsing
* ended. If $parse_pos > strlen($value), the parse fails immediately.
@@ -389,7 +389,7 @@ public function parse($value, &$position = null)
/**
* Set the formatter's calendar
*
- * @param string $calendar The calendar to use. Default is IntlDateFormatter::GREGORIAN.
+ * @param string $calendar The calendar to use. Default is IntlDateFormatter::GREGORIAN.
*
* @return Boolean true on success or false on failure
*
@@ -410,7 +410,7 @@ public function setCalendar($calendar)
* patterns, parsing as much as possible to obtain a value. Extra space, unrecognized tokens, or
* invalid values ("February 30th") are not accepted.
*
- * @param Boolean $lenient Sets whether the parser is lenient or not, default is false (strict)
+ * @param Boolean $lenient Sets whether the parser is lenient or not, default is false (strict)
*
* @return Boolean true on success or false on failure
*
@@ -426,7 +426,7 @@ public function setLenient($lenient)
/**
* Set the formatter's pattern
*
- * @param string $pattern A pattern string in conformance with the ICU IntlDateFormatter documentation
+ * @param string $pattern A pattern string in conformance with the ICU IntlDateFormatter documentation
*
* @return Boolean true on success or false on failure
*
@@ -445,7 +445,7 @@ public function setPattern($pattern)
/**
* Set the formatter's timezone identifier
*
- * @param string $timeZoneId The time zone ID string of the time zone to use.
+ * @param string $timeZoneId The time zone ID string of the time zone to use.
* If NULL or the empty string, the default time zone for the
* runtime is used.
*
View
64 Stub/StubLocale.php
@@ -74,7 +74,7 @@ class StubLocale
/**
* Returns the country names for a locale
*
- * @param string $locale The locale to use for the country names
+ * @param string $locale The locale to use for the country names
*
* @return array The country names with their codes as keys
*
@@ -98,7 +98,7 @@ static public function getCountries()
/**
* Returns the language names for a locale
*
- * @param string $locale The locale to use for the language names
+ * @param string $locale The locale to use for the language names
*
* @return array The language names with their codes as keys
*
@@ -122,7 +122,7 @@ static public function getLanguages()
/**
* Returns the locale names for a locale
*
- * @param string $locale The locale to use for the locale names
+ * @param string $locale The locale to use for the locale names
*
* @return array The locale names with their codes as keys
*
@@ -158,7 +158,7 @@ static public function getCurrenciesData($locale)
/**
* Returns the currencies names for a locale
*
- * @param string $locale The locale to use for the currencies names
+ * @param string $locale The locale to use for the currencies names
*
* @return array The currencies names with their codes as keys
*
@@ -192,7 +192,7 @@ static public function getCurrencies()
/**
* Returns the best available locale based on HTTP "Accept-Language" header according to RFC 2616
*
- * @param string $header The string containing the "Accept-Language" header value
+ * @param string $header The string containing the "Accept-Language" header value
*
* @return string The corresponding locale code
*
@@ -208,7 +208,7 @@ static public function acceptFromHttp($header)
/**
* Returns a correctly ordered and delimited locale code
*
- * @param array $subtags A keyed array where the keys identify the particular locale code subtag
+ * @param array $subtags A keyed array where the keys identify the particular locale code subtag
*
* @return string The corresponding locale code
*
@@ -224,8 +224,8 @@ static public function composeLocale(array $subtags)
/**
* Checks if a language tag filter matches with locale
*
- * @param string $langtag The language tag to check
- * @param string $locale The language range to check against
+ * @param string $langtag The language tag to check
+ * @param string $locale The language range to check against
* @param Boolean $canonicalize
*
* @return string The corresponding locale code
@@ -242,7 +242,7 @@ static public function filterMatches($langtag, $locale, $canonicalize = false)
/**
* Returns the variants for the input locale
*
- * @param string $locale The locale to extract the variants from
+ * @param string $locale The locale to extract the variants from
*
* @return array The locale variants
*
@@ -272,8 +272,8 @@ static public function getDefault()
/**
* Returns the localized display name for the locale language
*
- * @param string $locale The locale code to return the display language from
- * @param string $inLocale Optional format locale code to use to display the language name
+ * @param string $locale The locale code to return the display language from
+ * @param string $inLocale Optional format locale code to use to display the language name
*
* @return string The localized language display name
*
@@ -289,8 +289,8 @@ static public function getDisplayLanguage($locale, $inLocale = null)
/**
* Returns the localized display name for the locale
*
- * @param string $locale The locale code to return the display locale name from
- * @param string $inLocale Optional format locale code to use to display the locale name
+ * @param string $locale The locale code to return the display locale name from
+ * @param string $inLocale Optional format locale code to use to display the locale name
*
* @return string The localized locale display name
*
@@ -306,8 +306,8 @@ static public function getDisplayName($locale, $inLocale = null)
/**
* Returns the localized display name for the locale region
*
- * @param string $locale The locale code to return the display region from
- * @param string $inLocale Optional format locale code to use to display the region name
+ * @param string $locale The locale code to return the display region from
+ * @param string $inLocale Optional format locale code to use to display the region name
*
* @return string The localized region display name
*
@@ -323,8 +323,8 @@ static public function getDisplayRegion($locale, $inLocale = null)
/**
* Returns the localized display name for the locale script
*
- * @param string $locale The locale code to return the display script from
- * @param string $inLocale Optional format locale code to use to display the script name
+ * @param string $locale The locale code to return the display script from
+ * @param string $inLocale Optional format locale code to use to display the script name
*
* @return string The localized script display name
*
@@ -340,8 +340,8 @@ static public function getDisplayScript($locale, $inLocale = null)
/**
* Returns the localized display name for the locale variant
*
- * @param string $locale The locale code to return the display variant from
- * @param string $inLocale Optional format locale code to use to display the variant name
+ * @param string $locale The locale code to return the display variant from
+ * @param string $inLocale Optional format locale code to use to display the variant name
*
* @return string The localized variant display name
*
@@ -357,7 +357,7 @@ static public function getDisplayVariant($locale, $inLocale = null)
/**
* Returns the keywords for the locale
*
- * @param string $locale The locale code to extract the keywords from
+ * @param string $locale The locale code to extract the keywords from
*
* @return array Associative array with the extracted variants
*
@@ -373,7 +373,7 @@ static public function getKeywords($locale)
/**
* Returns the primary language for the locale
*
- * @param string $locale The locale code to extract the language code from
+ * @param string $locale The locale code to extract the language code from
*
* @return string|null The extracted language code or null in case of error
*
@@ -389,7 +389,7 @@ static public function getPrimaryLanguage($locale)
/**
* Returns the region for the locale
*
- * @param string $locale The locale code to extract the region code from
+ * @param string $locale The locale code to extract the region code from
*
* @return string|null The extracted region code or null if not present
*
@@ -405,7 +405,7 @@ static public function getRegion($locale)
/**
* Returns the script for the locale
*
- * @param string $locale The locale code to extract the script code from
+ * @param string $locale The locale code to extract the script code from
*
* @return string|null The extracted script code or null if not present
*
@@ -421,10 +421,10 @@ static public function getScript($locale)
/**
* Returns the closest language tag for the locale
*
- * @param array $langtag A list of the language tags to compare to locale
- * @param string $locale The locale to use as the language range when matching
- * @param Boolean $canonicalize If true, the arguments will be converted to canonical form before matching
- * @param string $default The locale to use if no match is found
+ * @param array $langtag A list of the language tags to compare to locale
+ * @param string $locale The locale to use as the language range when matching
+ * @param Boolean $canonicalize If true, the arguments will be converted to canonical form before matching
+ * @param string $default The locale to use if no match is found
*
* @see http://www.php.net/manual/en/locale.lookup.php
*
@@ -438,7 +438,7 @@ static public function lookup(array $langtag, $locale, $canonicalize = false, $d
/**
* Returns an associative array of locale identifier subtags
*
- * @param string $locale The locale code to extract the subtag array from
+ * @param string $locale The locale code to extract the subtag array from
*
* @return array Associative array with the extracted subtags
*
@@ -454,7 +454,7 @@ static public function parseLocale($locale)
/**
* Sets the default runtime locale
*
- * @param string $locale The locale code
+ * @param string $locale The locale code
*
* @return Boolean true on success or false on failure
*
@@ -470,9 +470,9 @@ static public function setDefault($locale)
/**
* Returns the stub ICU data
*
- * @param string $locale The locale code
- * @param string $cacheVariable The name of a static attribute to cache the data to
- * @param string $stubDataDir The stub data directory name
+ * @param string $locale The locale code
+ * @param string $cacheVariable The name of a static attribute to cache the data to
+ * @param string $stubDataDir The stub data directory name
*
* @return array
*
View
92 Stub/StubNumberFormatter.php
@@ -224,9 +224,9 @@ class StubNumberFormatter
/**
* Constructor
*
- * @param string $locale The locale code
- * @param int $style Style of the formatting, one of the format style constants
- * @param string $pattern A pattern string in case $style is NumberFormat::PATTERN_DECIMAL or
+ * @param string $locale The locale code
+ * @param int $style Style of the formatting, one of the format style constants
+ * @param string $pattern A pattern string in case $style is NumberFormat::PATTERN_DECIMAL or
* NumberFormat::PATTERN_RULEBASED. It must conform to the syntax
* described in the ICU DecimalFormat or ICU RuleBasedNumberFormat documentation
*
@@ -260,9 +260,9 @@ public function __construct($locale = 'en', $style = null, $pattern = null)
/**
* Static constructor
*
- * @param string $locale The locale code
- * @param int $style Style of the formatting, one of the format style constants
- * @param string $pattern A pattern string in case $style is NumberFormat::PATTERN_DECIMAL or
+ * @param string $locale The locale code
+ * @param int $style Style of the formatting, one of the format style constants
+ * @param string $pattern A pattern string in case $style is NumberFormat::PATTERN_DECIMAL or
* NumberFormat::PATTERN_RULEBASED. It must conform to the syntax
* described in the ICU DecimalFormat or ICU RuleBasedNumberFormat documentation
*
@@ -282,8 +282,8 @@ static public function create($locale = 'en', $style = null, $pattern = null)
/**
* Format a currency value
*
- * @param float $value The numeric currency value
- * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
+ * @param float $value The numeric currency value
+ * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
*
* @return string The formatted currency value
*
@@ -317,8 +317,8 @@ public function formatCurrency($value, $currency)
/**
* Format a number
*
- * @param number $value The value to format
- * @param int $type Type of the formatting, one of the format type constants
+ * @param number $value The value to format
+ * @param int $type Type of the formatting, one of the format type constants
*
* @return Boolean|string The formatted value or false on error
*
@@ -362,7 +362,7 @@ public function format($value, $type = self::TYPE_DEFAULT)
/**
* Returns an attribute value
*
- * @param int $attr An attribute specifier, one of the numeric attribute constants
+ * @param int $attr An attribute specifier, one of the numeric attribute constants
*
* @return Boolean|int The attribute value on success or false on error
*
@@ -400,7 +400,7 @@ public function getErrorMessage()
/**
* Returns the formatter's locale
*
- * @param int $type The locale name type to return between valid or actual (StubLocale::VALID_LOCALE or StubLocale::ACTUAL_LOCALE, respectively)
+ * @param int $type The locale name type to return between valid or actual (StubLocale::VALID_LOCALE or StubLocale::ACTUAL_LOCALE, respectively)
*
* @return string The locale name used to create the formatter
*
@@ -428,7 +428,7 @@ public function getPattern()
/**
* Returns a formatter symbol value
*
- * @param int $attr A symbol specifier, one of the format symbol constants
+ * @param int $attr A symbol specifier, one of the format symbol constants
*
* @return Boolean|string The symbol value or false on error
*
@@ -444,7 +444,7 @@ public function getSymbol($attr)
/**
* Returns a formatter text attribute value
*
- * @param int $attr An attribute specifier, one of the text attribute constants
+ * @param int $attr An attribute specifier, one of the text attribute constants
*
* @return Boolean|string The attribute value or false on error
*
@@ -460,9 +460,9 @@ public function getTextAttribute($attr)
/**
* Parse a currency number
*
- * @param string $value The value to parse
- * @param string $currency Parameter to receive the currency name (reference)
- * @param int $position Offset to begin the parsing on return this value will hold the offset at which the parsing ended
+ * @param string $value The value to parse
+ * @param string $currency Parameter to receive the currency name (reference)
+ * @param int $position Offset to begin the parsing on return this value will hold the offset at which the parsing ended
*
* @return Boolean|string The parsed numeric value of false on error
*
@@ -478,9 +478,9 @@ public function parseCurrency($value, &$currency, &$position = null)
/**
* Parse a number
*
- * @param string $value The value to parse
- * @param string $type Type of the formatting, one of the format type constants. NumberFormatter::TYPE_DOUBLE by default
- * @param int $position Offset to begin the parsing on return this value will hold the offset at which the parsing ended
+ * @param string $value The value to parse
+ * @param string $type Type of the formatting, one of the format type constants. NumberFormatter::TYPE_DOUBLE by default
+ * @param int $position Offset to begin the parsing on return this value will hold the offset at which the parsing ended
*
* @return Boolean|string The parsed value of false on error
*
@@ -525,8 +525,8 @@ public function parse($value, $type = self::TYPE_DOUBLE, &$position = null)
/**
* Set an attribute
*
- * @param int $attr An attribute specifier, one of the numeric attribute constants
- * @param int $value The attribute value
+ * @param int $attr An attribute specifier, one of the numeric attribute constants
+ * @param int $value The attribute value
*
* @return Boolean true on success or false on failure
*
@@ -572,7 +572,7 @@ public function setAttribute($attr, $value)
/**
* Set the formatter's pattern
*
- * @param string $pattern A pattern string in conformance with the ICU DecimalFormat documentation
+ * @param string $pattern A pattern string in conformance with the ICU DecimalFormat documentation
*
* @return Boolean true on success or false on failure
*
@@ -589,8 +589,8 @@ public function setPattern($pattern)
/**
* Set the formatter's symbol
*
- * @param int $attr A symbol specifier, one of the format symbol constants
- * @param string $value The value for the symbol
+ * @param int $attr A symbol specifier, one of the format symbol constants
+ * @param string $value The value for the symbol
*
* @return Boolean true on success or false on failure
*
@@ -606,8 +606,8 @@ public function setSymbol($attr, $value)
/**
* Set a text attribute
*
- * @param int $attr An attribute specifier, one of the text attribute constants
- * @param int $value The attribute value
+ * @param int $attr An attribute specifier, one of the text attribute constants
+ * @param int $value The attribute value
*
* @return Boolean true on success or false on failure
*
@@ -640,8 +640,8 @@ protected function resetError()
*
* The only actual rounding data as of this writing, is CHF.
*
- * @param float $value The numeric currency value
- * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
+ * @param float $value The numeric currency value
+ * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
*
* @return string The rounded numeric currency value
*
@@ -668,7 +668,7 @@ private function roundCurrency($value, $currency)
/**
* Returns the currency symbol
*
- * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
+ * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
*
* @return string The currency symbol
*/
@@ -682,7 +682,7 @@ private function getCurrencySymbol($currency)
/**
* Returns the fraction digits of a currency
*
- * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
+ * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
*
* @return string The fraction digits of a currency
*/
@@ -696,7 +696,7 @@ private function getCurrencyFractionDigits($currency)
/**
* Returns the rounding increment of a currency
*
- * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
+ * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
*
* @return string The rounding increment of a currency
*/
@@ -710,8 +710,8 @@ private function getCurrencyRoundingIncrement($currency)
/**
* Rounds a value.
*
- * @param numeric $value The value to round
- * @param int $precision The number of decimal digits to round to
+ * @param numeric $value The value to round
+ * @param int $precision The number of decimal digits to round to
*
* @return numeric The rounded value
*/
@@ -728,8 +728,8 @@ private function round($value, $precision)
/**
* Formats a number.
*
- * @param numeric $value The numeric value to format
- * @param int $precision The number of decimal digits to use
+ * @param numeric $value The numeric value to format
+ * @param int $precision The number of decimal digits to use
*
* @return string The formatted number
*/
@@ -743,8 +743,8 @@ private function formatNumber($value, $precision)
/**
* Returns the precision value if the the DECIMAL style is being used and the FRACTION_DIGITS attribute is unitialized.
*
- * @param numeric $value The value to get the precision from if the FRACTION_DIGITS attribute is unitialized
- * @param int $precision The precision value to returns if the FRACTION_DIGITS attribute is initialized
+ * @param numeric $value The value to get the precision from if the FRACTION_DIGITS attribute is unitialized
+ * @param int $precision The precision value to returns if the FRACTION_DIGITS attribute is initialized
*
* @return int The precision value
*/
@@ -767,7 +767,7 @@ private function getUnitializedPrecision($value, $precision)
/**
* Check if the attribute is initialized (value set by client code).
*
- * @param string $attr The attribute name
+ * @param string $attr The attribute name
*
* @return Boolean true if the value was set by client, false otherwise
*/
@@ -779,8 +779,8 @@ private function isInitializedAttribute($attr)
/**
* Returns the numeric value using the $type to convert to the right data type.
*
- * @param mixed $value The value to be converted
- * @param int $type The type to convert. Can be TYPE_DOUBLE (float) or TYPE_INT32 (int)
+ * @param mixed $value The value to be converted
+ * @param int $type The type to convert. Can be TYPE_DOUBLE (float) or TYPE_INT32 (int)
*
* @return numeric The converted value
*/
@@ -800,7 +800,7 @@ private function convertValueDataType($value, $type)
/**
* Convert the value data type to int or returns false if the value is out of the integer value range.
*
- * @param mixed $value The value to be converted
+ * @param mixed $value The value to be converted
*
* @return int The converted value
*/
@@ -816,7 +816,7 @@ private function getInt32Value($value)
/**
* Convert the value data type to int or returns false if the value is out of the integer value range.
*
- * @param mixed $value The value to be converted
+ * @param mixed $value The value to be converted
*
* @return int|float The converted value
*/
@@ -840,7 +840,7 @@ private function getInt64Value($value)
/**
* Check if the rounding mode is invalid.
*
- * @param int $value The rounding mode value to check
+ * @param int $value The rounding mode value to check
*
* @return Boolean true if the rounding mode is invalid, false otherwise
*/
@@ -857,7 +857,7 @@ private function isInvalidRoundingMode($value)
* Returns the normalized value for the GROUPING_USED attribute. Any value that can be converted to int will be
* cast to Boolean and then to int again. This way, negative values are converted to 1 and string values to 0.
*
- * @param mixed $value The value to be normalized
+ * @param mixed $value The value to be normalized
*
* @return int The normalized value for the attribute (0 or 1)
*/
@@ -870,7 +870,7 @@ private function normalizeGroupingUsedValue($value)
* Returns the normalized value for the FRACTION_DIGITS attribute. The value is converted to int and if negative,
* the returned value will be 0.
*
- * @param mixed $value The value to be normalized
+ * @param mixed $value The value to be normalized
*
* @return int The normalized value for the attribute
*/

0 comments on commit cba1552

Please sign in to comment.