PHP String

<?php
if (function_exists("String") == false) {
	function String($value = "")
	{
		return new String($value);
	}
}
final class String
{
	private $value;
	private $count;
	public function __construct($value = "")
	{
		$this->value = (string) $value;
		$this->count = strlen($this->value);
	}
	public function __destruct() {
		$this->value = "";
		$this->count = 0;
	}
	public function charAt($index)
	{	
		if ($index < 0 || $index >= $this->count) {
			throw new Exception("String index out of range: " . $index);
		}
		return $this->value[$index];
	}
	public function codePointAt($index)
	{
		return ord($this->charAt($index));
	}
	public function compareTo($str)
	{
		return strcmp($this->value, $str);
	}
	public function compareToIgnoreCase($str)
	{
		return strcasecmp($this->value, $str);
	}
	public function concat($str)
	{
		return new String($this->value . $str);
	}
	public function contains($str)
	{
		return $this->indexOf($str) > -1;
	}
	public function endsWith($str)
	{
		return preg_match("/" . preg_quote($suffix) . "$/", $this->value);
	}
	public function equals($str)
	{
		return $this->compareTo($str) == 0;
	}
	public function equalsIgnoreCase($str)
	{
		return $this->compareToIgnoreCase($str) == 0;
	}
	public static function format()
	{
		$args = func_get_args();
		if (count($args) > 0) {
			return new String(call_user_func_array("sprintf", $args));
		}
	}
	public function hashCode()
	{
		$h = 0;
		for ($i = 0, $l = $this->count; $i < $l; $i++) {
			$h = 31 * $h + $this->codePointAt($i);
		}
		return $h;
	}
	public function indexOf($str, $fromIndex = null)
	{
		if ($fromIndex == null) {
			$index = strpos($this->value, $str);
		} else {
			if ($fromIndex < 0 || $fromIndex >= $this->count) {
				throw new Exception("String index out of range: " . $fromIndex);
			}
			$index = strpos($this->value, $str, $fromIndex);
		}
		return ($index != false) ? $index : -1;
	}
	public function isEmpty()
	{
		return $this->count == 0;
	}
	public function lastIndexOf($str, $fromIndex = null)
	{
		if ($fromIndex == null) {
			$index = strrpos($this->value, $str);
		} else {
			if ($fromIndex < 0 || $fromIndex >= $this->count) {
				throw new Exception("String index out of range: " . $fromIndex);
			}
			$index = strrpos($this->value, $str, $fromIndex);
		}
		return ($index != false) ? $index : -1;
	}
	public function length()
	{
		return $this->count;
	}
	public function matches($regex)
	{
		return preg_match($regex, $this->value) == 1;
	}
	public function regionMatches($offsetA, $str, $offsetB, $length)
	{
		if ($str instanceof String == false) {
			$str = new String($str);
		}
		return $this->substring($offsetA, $length)->equals($str->substring($offsetB, $length));
	}
	public function regionMatchesIgnoreCase($offsetA, $str, $offsetB, $length)
	{
		if ($str instanceof String == false) {
			$str = new String($str);
		}
		return $this->substring($offsetA, $length)->equalsIgnoreCase($str->substring($offsetB, $length));
	}
	public function replace($old, $new)
	{
		return new String(str_replace($old, $new, $this->value));
	}
	public function replaceAll($regex, $str, $limit = null)
	{
		if ($limit == null) {
			return new String(preg_replace($regex, $str, $this->value));
		}
		return new String(preg_replace($regex, $str, $this->value, $limit));
	}
	public function replaceFirst($regex, $str)
	{
		return $this->replaceAll($regex, $str, 1);
	}
	public function reverse()
	{
		return new String(strrev($this->value));
	}
	public function split($regex, $limit = null)
	{
		return preg_split($regex, $this->value, $limit);
	}
	public function startsWith($prefix)
	{
		return preg_match("/^" . preg_quote($prefix) . "/", $this->value);
	}
	public function substring($beginIndex, $endIndex = null)
	{
		if ($endIndex == null) {
			$endIndex = $this->count - 1;
		}
		if ($beginIndex < 0) {
			throw new Exception("String index out of range: " . $beginIndex);
		}
		if ($endIndex >= $this->count) {
			throw new Exception("String index out of range: " . $endIndex);
		}
		if ($beginIndex > $endIndex) {
			throw new Exception("String index out of range: " . $endIndex - $beginIndex);
		}
		return new String(substr($this->value, $beginIndex, $endIndex - $beginIndex + 1));
	}
	public function toLowerCase()
	{
		return new String(strtolower($this->value));
	}
	public function toUpperCase()
	{
		return new String(strtoupper($this->value));
	}
	public function trim()
	{
		return new String(trim($this->value));
	}
	public function __toString()
	{
		return $this->value;
	}
}
// EOF: String.php