StringObject\AnyStrObj

Complexity

Total Complexity

11

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	__get()	0	4	1
A	__toString()	0	4	1
	compareTo()	0	1	?
A	asciify()	0	11	3
	escape()	0	1	?
	nextToken()	0	1	?
	remove()	0	1	?
	repeat()	0	1	?
	replace()	0	1	?
	resetToken()	0	1	?
	times()	0	1	?
	translate()	0	1	?
	trim()	0	1	?
	unescape()	0	1	?
	uuDecode()	0	1	?
	uuEncode()	0	1	?
A	equals()	0	7	1
	isAscii()	0	1	?
	isEmpty()	0	1	?
A	testStringableObject()	0	10	4

<?php

namespace StringObject;

abstract class AnyStrObj
{
    protected $raw;

    public function __construct($thing)
    {
        self::testStringableObject($thing);
        $this->raw = (string) $thing;
    }

    /**
     * @return mixed
     */
    public function __get($name)
    {
        return $this->$name;
    }

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

    public abstract function compareTo($str, $mode = self::NORMAL, $length = 1);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public function asciify($removeUnsupported = true)
    {
        $str = $this->raw;
        foreach (self::$asciimap as $key => $value) {
            $str = \str_replace($value, $key, $str);
        }
        if ($removeUnsupported) {
            $str = \preg_replace('/[^\x20-\x7E]/u', '', $str);
        }
        return new self($str);
    }

    public abstract function escape($mode = self::NORMAL, $charlist = '');

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function nextToken($delim);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function remove($str, $mode = self::NORMAL);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function repeat($times);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    /**
     * @param string $replace
     */
    public abstract function replace($search, $replace, $mode = self::NORMAL);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function resetToken();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function times($times);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function translate($search, $replace = '');

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function trim($mask = " \t\n\r\0\x0B", $mode = self::BOTH_ENDS);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function unescape($mode = self::NORMAL);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function uuDecode();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function uuEncode();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public function equals($str)
    {
        self::testStringableObject($str);

        $str = (string) $str;
        return ($str == $this->raw);
    }

    public abstract function isAscii();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    public abstract function isEmpty();

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

The abstract declaration must precede the visibility declaration

    protected static function testStringableObject($thing)
    {
        if (\is_object($thing) && !\method_exists($thing, '__toString')) {
            throw new \InvalidArgumentException(
                'Parameter is an object that does not implement __toString() method'
            );
        } elseif (\is_array($thing)) {
            throw new \InvalidArgumentException('Unsure of how to convert array to string');
        }
    }
}