Multiline::prefix() - Code Metrics - Inspection of "docs: Prepare 0.3.6 release" - nochso/omni - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1688fd...eb1d12 )

by Marcel

created 2016-04-07 19:34 UTC

Multiline::prefix() A

↳ Parent: Multiline

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
c	3
b	0
f	1
dl	0
loc	7
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

<?php
namespace nochso\Omni;

/**
 * Multiline string class for working with lines of text.
 */
final class Multiline extends ArrayCollection
{
    /**
     * @var \nochso\Omni\EOL
     */
    private $eol;

    /**
     * Create a new Multiline object from a string.
     *
     * First the input string is split into lines by the detected end-of-line
     * character. Afterwards any extra EOL chars will be trimmed.
     *
     * @see \nochso\Omni\EOL
     *
     * @param string $input      A string to split into a Multiline object
     * @param string $defaultEol Default end-of-line type to split the input by. This is a fallback in case it could
     *                           not be detected from the input string. Optional, defaults to `EOL::EOL_LF` i.e. "\n".
     *                           See the `EOL::EOL_*` class constants.
     *
     * @return \nochso\Omni\Multiline
     */
    public static function create($input, $defaultEol = \nochso\Omni\EOL::EOL_LF)
    {
        $eol = EOL::detectDefault($input, $defaultEol);
        $lines = explode($eol, $input);
        $multiline = new self($lines);
        // Remove left-over line feeds
        $multiline->apply(function ($line) {
            return trim($line, "\r\n");
        });
        $multiline->setEol($eol);
        return $multiline;
    }

    /**
     * __toString returns a single string using the current EOL style.
     *
     * @return string
     */
    public function __toString()
    {
        return implode((string) $this->eol, $this->list);
    }

    /**
     * Get EOL style ending.
     *
     * @return \nochso\Omni\EOL
     */
    public function getEol()
    {
        return $this->eol;
    }

    /**
     * getMaxLength of all lines.
     *
     * @return int
     */
    public function getMaxLength()
    {
        $length = 0;
        foreach ($this->list as $line) {
            $length = max($length, mb_strlen($line));
        }
        return $length;
    }

    /**
     * Set EOL used by this Multiline string.
     *
     * @param \nochso\Omni\EOL|string $eol Either an `EOL` object or a string ("\r\n" or "\n")
     *
     * @return $this
     */
    public function setEol($eol)
    {
        if (!$eol instanceof EOL) {
            $eol = new EOL($eol);
        }
        $this->eol = $eol;
        return $this;
    }

    /**
     * Append text to a certain line.
     *
     * @param string   $text
     * @param null|int $index Optional, defaults to the last line. Other
     *
     * @return $this
     */
    public function append($text, $index = null)
    {
        if ($index === null) {
            $index = count($this) - 1;
        }
        $this->list[$index] .= $text;
        return $this;
    }

    /**
     * Prefix all lines with a string.
     *
     * @param string $prefix The prefix to add to the start of the string.
     *
     * @return string
     */
    public function prefix($prefix)
    {
        $prefixer = function ($line) use ($prefix) {
            return $prefix . $line;
        };
        return $this->apply($prefixer);
    }

    /**
     * Pad all lines to the same length using `str_pad`.
     *
     * @param int    $length      If length is larger than the maximum line length, all lines will be padded up to the
     *                            given length. If length is null, the maximum of all line lengths is used. Optional,
     *                            defaults to null.
     * @param string $padding     Optional, defaults to a space character. Can be more than one character. The padding
     *                            may be truncated if the required number of padding characters can't be evenly
     *                            divided.
     * @param int    $paddingType Optional argument pad_type can be STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH.
     *                            Defaults to STR_PAD_RIGHT.
     *
     * @return string
     */
    public function pad($length = null, $padding = ' ', $paddingType = STR_PAD_RIGHT)
    {
        if ($length === null) {
            $length = $this->getMaxLength();
        }
        $padder = function ($line) use ($length, $padding, $paddingType) {
            return Strings::padMultibyte($line, $length, $padding, $paddingType);
        };
        return $this->apply($padder);
    }

    /**
     * getLineIndexByCharacterPosition returns the line index containing a certain position.
     *
     * @param int $characterPosition Position of a character as if Multiline was a raw string.
     *
     * @return int|null The array index of the line containing the character position.
     */
    public function getLineIndexByCharacterPosition($characterPosition)
    {
        $position = 0;
        foreach ($this->list as $key => $line) {
            $length = mb_strlen($line . $this->getEol());
            if ($characterPosition >= $position && $characterPosition <= $position + $length) {
                return $key;
            }
            $position += $length;
        }
        return null;
    }
}


1			<?php
2			namespace nochso\Omni;
3
4			/**
5			* Multiline string class for working with lines of text.
6			*/
7			final class Multiline extends ArrayCollection
8			{
9			/**
10			* @var \nochso\Omni\EOL
11			*/
12			private $eol;
13
14			/**
15			* Create a new Multiline object from a string.
16			*
17			* First the input string is split into lines by the detected end-of-line
18			* character. Afterwards any extra EOL chars will be trimmed.
19			*
20			* @see \nochso\Omni\EOL
21			*
22			* @param string $input A string to split into a Multiline object
23			* @param string $defaultEol Default end-of-line type to split the input by. This is a fallback in case it could
24			* not be detected from the input string. Optional, defaults to `EOL::EOL_LF` i.e. "\n".
25			* See the `EOL::EOL_*` class constants.
26			*
27			* @return \nochso\Omni\Multiline
28			*/
29			public static function create($input, $defaultEol = \nochso\Omni\EOL::EOL_LF)
30			{
31			$eol = EOL::detectDefault($input, $defaultEol);
32			$lines = explode($eol, $input);
33			$multiline = new self($lines);
34			// Remove left-over line feeds
35			$multiline->apply(function ($line) {
36			return trim($line, "\r\n");
37			});
38			$multiline->setEol($eol);
39			return $multiline;
40			}
41
42			/**
43			* __toString returns a single string using the current EOL style.
44			*
45			* @return string
46			*/
47			public function __toString()
48			{
49			return implode((string) $this->eol, $this->list);
50			}
51
52			/**
53			* Get EOL style ending.
54			*
55			* @return \nochso\Omni\EOL
56			*/
57			public function getEol()
58			{
59			return $this->eol;
60			}
61
62			/**
63			* getMaxLength of all lines.
64			*
65			* @return int
66			*/
67			public function getMaxLength()
68			{
69			$length = 0;
70			foreach ($this->list as $line) {
71			$length = max($length, mb_strlen($line));
72			}
73			return $length;
74			}
75
76			/**
77			* Set EOL used by this Multiline string.
78			*
79			* @param \nochso\Omni\EOL\|string $eol Either an `EOL` object or a string ("\r\n" or "\n")
80			*
81			* @return $this
82			*/
83			public function setEol($eol)
84			{
85			if (!$eol instanceof EOL) {
86			$eol = new EOL($eol);
87			}
88			$this->eol = $eol;
89			return $this;
90			}
91
92			/**
93			* Append text to a certain line.
94			*
95			* @param string $text
96			* @param null\|int $index Optional, defaults to the last line. Other
97			*
98			* @return $this
99			*/
100			public function append($text, $index = null)
101			{
102			if ($index === null) {
103			$index = count($this) - 1;
104			}
105			$this->list[$index] .= $text;
106			return $this;
107			}
108
109			/**
110			* Prefix all lines with a string.
111			*
112			* @param string $prefix The prefix to add to the start of the string.
113			*
114			* @return string
115			*/
116			public function prefix($prefix)
117			{
118			$prefixer = function ($line) use ($prefix) {
119			return $prefix . $line;
120			};
121			return $this->apply($prefixer);
122			}
123
124			/**
125			* Pad all lines to the same length using `str_pad`.
126			*
127			* @param int $length If length is larger than the maximum line length, all lines will be padded up to the
128			* given length. If length is null, the maximum of all line lengths is used. Optional,
129			* defaults to null.
130			* @param string $padding Optional, defaults to a space character. Can be more than one character. The padding
131			* may be truncated if the required number of padding characters can't be evenly
132			* divided.
133			* @param int $paddingType Optional argument pad_type can be STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH.
134			* Defaults to STR_PAD_RIGHT.
135			*
136			* @return string
137			*/
138			public function pad($length = null, $padding = ' ', $paddingType = STR_PAD_RIGHT)
139			{
140			if ($length === null) {
141			$length = $this->getMaxLength();
142			}
143			$padder = function ($line) use ($length, $padding, $paddingType) {
144			return Strings::padMultibyte($line, $length, $padding, $paddingType);
145			};
146			return $this->apply($padder);
147			}
148
149			/**
150			* getLineIndexByCharacterPosition returns the line index containing a certain position.
151			*
152			* @param int $characterPosition Position of a character as if Multiline was a raw string.
153			*
154			* @return int\|null The array index of the line containing the character position.
155			*/
156			public function getLineIndexByCharacterPosition($characterPosition)
157			{
158			$position = 0;
159			foreach ($this->list as $key => $line) {
160			$length = mb_strlen($line . $this->getEol());
161			if ($characterPosition >= $position && $characterPosition <= $position + $length) {
162			return $key;
163			}
164			$position += $length;
165			}
166			return null;
167			}
168			}
169

nochso / omni

Push — master ( 1688fd...eb1d12 )

Multiline::prefix() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like