1
0
mirror of https://github.com/danielstjules/Stringy.git synced 2025-08-13 00:34:11 +02:00

Update readmewith OO/Procedural info, fix instances where is called instead of ->str

This commit is contained in:
Daniel St. Jules
2013-07-25 23:02:34 -04:00
parent 4e2a3a4bec
commit 571cf8f78f
2 changed files with 23 additions and 4 deletions

View File

@@ -1,6 +1,6 @@
# Stringy
A PHP library with a variety of string manipulation functions with multibyte support. It contains both an OO and Static wrapper. Inspired by underscore.string.js.
A PHP library with a variety of string manipulation functions with multibyte support. Offers both OO method chaining and a procedural-style static wrapper. Inspired by underscore.string.js.
Note: The methods listed below are subject to change until we reach a 1.0.0 release.
@@ -70,7 +70,26 @@ use Stringy\StaticStringy as S;
## OO & Procedural
Documentation coming soon.
The library offers both OO method chaining with `Stringy\Stringy`, as well as
procedural-style static method calls with `Stringy\StaticStringy`. An example
of the former is the following:
```php
use Stringy\Stringy as S;
echo S::create("Fòô Bàř", 'UTF-8')->collapseWhitespace()->swapCase(); // 'fÒÔ bÀŘ'
```
`Stringy\Stringy` contains a __toString() method, which returns the current
string when the object is used in a string context. Its $str property is also
public, and can be accessed directly if required, ie: `S::create('foo')->str // 'foo'`
Using the static wrapper, an alternative is the following:
```php
use Stringy\StaticStringy as S;
$string = S::collapseWhitespace("Fòô Bàř", 'UTF-8');
echo S::swapCase($string, 'UTF-8'); // 'fÒÔ bÀŘ''
```
## Methods

View File

@@ -176,7 +176,7 @@ class Stringy
else
return mb_strtoupper($match[0], $encoding);
},
$this
$this->str
);
return $this;
@@ -204,7 +204,7 @@ class Stringy
$that->str = $match[0];
return $that->upperCaseFirst();
},
$this->trim()
$this->trim()->str
);
return $this;