markenwerk/string-builder

A string builder library providing different string methods written in PHP.

PHP String Builder

, _(*1)

A basic string builder library providing different string methods written in PHP., _(*2)

Installation

```{json} { "require": { "chroma-x/string-builder": "~1.0" } }, <sub>(*3)</sub>

## Usage

### Autoloading and namesapce

```{php}  
require_once('path/to/vendor/autoload.php');

Building and modifying a string

```{php} use ChromaX\StringBuilder\StringBuilder;, <sub>(*4)</sub>

$builder = new StringBuilder('rolod muspi meroL'); $builder ->reverse() ->append(' sit amet, consetetur') ->append(12) ->append(false) ->prepend('b') ->append(true) ->insert(1, 'qäs') ->replace(6, 2, 'wertz') ->setCharAt(4, '2') ->delete(0, 2) ->delete(40) ->deleteCharAt(3);, <sub>(*5)</sub>

$result = $builder->build(); fwrite(STDOUT, ' 1. Built string ' . $result . PHP_EOL);, <sub>(*6)</sub>

$result = $builder->buildSubstring(5, 2); fwrite(STDOUT, ' 2. Built substring ' . $result . PHP_EOL);, <sub>(*7)</sub>

$result = $builder->buildSubstring(5); fwrite(STDOUT, ' 3. Built substring ' . $result . PHP_EOL);, <sub>(*8)</sub>

$result = $builder->charAt(5); fwrite(STDOUT, ' 4. Character at position 5 ' . $result . PHP_EOL);, <sub>(*9)</sub>

$result = $builder->firstChar(); fwrite(STDOUT, ' 5. First character ' . $result . PHP_EOL);, <sub>(*10)</sub>

$result = $builder->lastChar(); fwrite(STDOUT, ' 6. Last character ' . $result . PHP_EOL);, <sub>(*11)</sub>

will output the following

```{txt}
 1. Built string                                          ä2wertzem ipsum dolor sit amet, conset
 2. Built substring                                       rt
 3. Built substring                                       rtzem ipsum dolor sit amet, conset
 4. Character at position 5                               r
 5. First character                                       ä
 6. Last character                                        t

Getting string properties

```{php} $result = $builder->length(); fwrite(STDOUT, ' 7. String length ' . $result . PHP_EOL);, <sub>(*12)</sub>

$result = $builder->size(); fwrite(STDOUT, ' 8. Number of bytes ' . $result . PHP_EOL);, <sub>(*13)</sub>

$result = $builder->indexOf('e'); fwrite(STDOUT, ' 9. First occurence of "e" ' . $result . PHP_EOL);, <sub>(*14)</sub>

$result = $builder->indexOf('e', 5); fwrite(STDOUT, '10. First occurence of "e" after position 5 ' . $result . PHP_EOL);, <sub>(*15)</sub>

$result = $builder->lastIndexOf('e'); fwrite(STDOUT, '11. Last occurence of "e" ' . $result . PHP_EOL);, <sub>(*16)</sub>

$result = $builder->lastIndexOf('e', 5); fwrite(STDOUT, '12. Last occurence of "e" before the 5th last character ' . $result . PHP_EOL);, <sub>(*17)</sub>

$result = $builder->contains('ipsum'); fwrite(STDOUT, '13. Whether the string contains "ipsum" ' . $result . PHP_EOL);, <sub>(*18)</sub>

will output the following

```{txt}
 7. String length                                         38
 8. Number of bytes                                       39
 9. First occurence of "e"                                4
10. First occurence of "e" after position 5               8
11. Last occurence of "e"                                 37
12. Last occurence of "e" before the 5th last character   29
13. Whether the string contains "ipsum"                   <TRUE>

Exception handling

All methods throw an \InvalidArgumentException if misconfigured except indexOf and lastIndexOf wich return null if the given subtring is not contained by the string to build., <sub>(*19)</sub>

```{php} use ChromaX\StringBuilder\StringBuilder;, <sub>(*20)</sub>

try { $builder = new StringBuilder();, <sub>(*21)</sub>

$result = $builder->indexOf('a');
fwrite(STDOUT, '1. Result                 ' . $result . PHP_EOL);

$result = $builder->lastIndexOf('a');
fwrite(STDOUT, '2. Result                 ' . $result . PHP_EOL);

$result = $builder->charAt(10);
fwrite(STDOUT, '3. Result                 ' . $result . PHP_EOL);

} catch (\InvalidArgumentException $exception) { fwrite(STDERR, 'Exception with message ' . $exception->getMessage() . PHP_EOL); }, <sub>(*22)</sub>

will output the following

```{txt}
1. Result                 <NULL>
2. Result                 <NULL>
Exception with message    Position invalid

Contribution

Contributing to our projects is always very appreciated.
But: please follow the contribution guidelines written down in the CONTRIBUTING.md document., <sub>(*23)</sub>

License

PHP String Builder is under the MIT license., <sub>(*24)</sub>