voku / Stringy

   *

   * @return static <p>Object with the resulting $str after the insertion.</p>

   */

  public function insert(string $substring, int $index): Stringy

  {

    $stringy = static::create($this->str, $this->encoding);

    if ($index > $stringy->length()) {

      return $stringy;

    }

    $start = UTF8::substr($stringy->str, 0, $index, $stringy->encoding);

    $end = UTF8::substr($stringy->str, $index, $stringy->length(), $stringy->encoding);

    $stringy->str = $start . $substring . $end;

    return $stringy;

  }

  /**

   * Returns true if the string contains the $pattern, otherwise false.

   *

   * @return static <p>Object with the resulting $str after truncating.</p>

   */

  public function truncate(int $length, string $substring = ''): Stringy

  {

    $stringy = static::create($this->str, $this->encoding);

    if ($length >= $stringy->length()) {

      return $stringy;

    }

    // Need to further trim the string so we can append the substring

    $substringLength = UTF8::strlen($substring, $stringy->encoding);

    $length -= $substringLength;

    $truncated = UTF8::substr($stringy->str, 0, $length, $stringy->encoding);

    $stringy->str = $truncated . $substring;

    return $stringy;

  }

  /**

   * Returns a lowercase and trimmed string separated by underscores.