publishing-kit / utilities

src/Str.php

<?php

declare(strict_types=1);

namespace PublishingKit\Utilities;

use Countable;
use ArrayAccess;
use Iterator;
use PublishingKit\Utilities\Contracts\Stringable;
use PublishingKit\Utilities\Traits\Macroable;
use Serializable;

/**
 * String class
 * @psalm-consistent-constructor
 */
class Str implements Countable, ArrayAccess, Iterator, Stringable, Serializable
{
    use Macroable;

    /**
     * String
     *
     * @var string
     */
    protected $string;

    /**
     * Position
     *
     * @var integer
     */
    protected $position = 0;

    /**
     * Constructor
     *
     * @param string $string String to use.
     * @return void
     */
    public function __construct(string $string = '')
    {
        $this->string = $string;
    }

    /**
     * Create string
     *
     * @param string $string String to use.
     * @return Stringable
     */
    public static function make(string $string): Stringable
    {
        return new static($string);
    }

    /**
     * Return count of characters
     *
     * @return integer
     */
    public function count(): int
    {
        return strlen($this->string);
    }

    /**
     * Does item exist?
     *
     * @param mixed $offset The offset.
     * @return boolean
     */
    public function offsetExists($offset): bool
    {
        return isset($this->string[$offset]);
    }

    /**
     * Get offset
     *
     * @param mixed $offset The offset.
     * @return mixed
     */
    public function offsetGet($offset)
    {
        return isset($this->string[$offset]) ? $this->string[$offset] : null;
    }

    /**
     * Set offset
     *
     * @param mixed $offset The offset.
     * @param mixed $value  The value to set.
     * @return void
     */
    public function offsetSet($offset, $value): void
    {
        if (is_null($offset)) {
            $this->string .= $value;
            return;
        }
        $this->string[$offset] = $value;
    }

    /**
     * Unset offset
     *
     * @param mixed $offset The offset.
     * @return void
     */
    public function offsetUnset($offset)
    {
        $this->string = substr_replace($this->string, '', $offset, 1);

It seems like substr_replace($this->string, '', $offset, 1) can also be of type array. However, the property $string is declared as type string. Maybe add an additional type check?

    }

    /**
     * Get current item
     *
     * @return mixed
     */
    public function current()
    {
        return $this->string[$this->position];
    }

    /**
     * Get key for current item
     *
     * @return mixed
     */
    public function key()
    {
        return $this->position;
    }

    /**
     * Move counter to next item
     *
     * @return void
     */
    public function next()
    {
        ++$this->position;
    }

    /**
     * Move counter back to zero
     *
     * @return void
     */
    public function rewind()
    {
        $this->position = 0;
    }

    /**
     * Is current item valid?
     *
     * @return boolean
     */
    public function valid(): bool
    {
        return isset($this->string[$this->position]);
    }

    /**
     * Convert to string
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->string;
    }

    /**
     * Find and replace text
     *
     * @param string $find    Text to find.
     * @param string $replace Text to replace.
     * @return Stringable
     */
    public function replace(string $find, string $replace): Stringable
    {
        return new static(str_replace($find, $replace, $this->string));
    }

    /**
     * Convert to upper case
     *
     * @return Stringable
     */
    public function toUpper(): Stringable
    {
        return new static(strtoupper($this->string));
    }

    /**
     * Convert to lower case
     *
     * @return Stringable
     */
    public function toLower(): Stringable
    {
        return new static(strtolower($this->string));
    }

    /**
     * Trim whitespace
     *
     * @return Stringable
     */
    public function trim(): Stringable
    {
        return new static(trim($this->string));
    }

    /**
     * Trim left whitespace
     *
     * @return Stringable
     */
    public function ltrim(): Stringable
    {
        return new static(ltrim($this->string));
    }

    /**
     * Trim right whitespace
     *
     * @return Stringable
     */
    public function rtrim(): Stringable
    {
        return new static(rtrim($this->string));
    }

    /**
     * Handle path in a platform-independent way
     *
     * @return Stringable
     */
    public function path(): Stringable
    {
        return new static(preg_replace('/(\\\|\/)/', DIRECTORY_SEPARATOR, $this->string));
    }

    /**
     * {@inheritDoc}
     */
    public function serialize()
    {
        return serialize($this->string);
    }

    /**
     * {@inheritDoc}
     */
    public function unserialize($serialized)
    {
        /** @var string **/
        $this->string = unserialize($serialized);
    }

    public function __debugInfo()
    {
        return $this->__toString();
    }
}