mirror/stringy
1
0
Fork 0
mirror of https://github.com/danielstjules/Stringy.git synced 2025-08-12 00:04:11 +02:00
Code Issues Releases Wiki Activity

Cleanup comments, release 1.1.0

Browse Source
This commit is contained in:
Daniel St. Jules
2013-08-31 19:30:47 -04:00
parent a667c4aa6a
commit 63298f36a8
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Stringy/Stringy.php
View File

@@ -9,12 +9,12 @@ class Stringy
public $encoding; public $encoding;
/** /**
* Inializes a Stringy object and assigns both str and encoding properties * Initializes a Stringy object and assigns both str and encoding properties
* the supplied values. If $encoding is not specified, it defaults to * the supplied values. If $encoding is not specified, it defaults to
* mb_internal_encoding(). * mb_internal_encoding().
* *
* @param string $str String to modify * @param string $str String to modify
* @param string $encoding The character encoding * @param string $encoding The character encoding
*/ */
public function __construct($str, $encoding = null) public function __construct($str, $encoding = null)
{ {
@@ -349,9 +349,9 @@ class Stringy
* 'right', 'both') is 'right'. Throws an InvalidArgumentException if * 'right', 'both') is 'right'. Throws an InvalidArgumentException if
* $padType isn't one of those 3 values. * $padType isn't one of those 3 values.
* *
* @param int $length Desired string length after padding * @param int $length Desired string length after padding
* @param string $padStr String used to pad, defaults to space * @param string $padStr String used to pad, defaults to space
* @param string $padType One of 'left', 'right', 'both' * @param string $padType One of 'left', 'right', 'both'
* @return Stringy Object with a padded $str * @return Stringy Object with a padded $str
* @throws InvalidArgumentException If $padType isn't one of 'right', * @throws InvalidArgumentException If $padType isn't one of 'right',
* 'left' or 'both' * 'left' or 'both'