Apply fixes from StyleCI

src/Contracts/Converter.phpmodifiedformatting only+6-6

Changes to src/Contracts/Converter.php

		⋯6 linesShow the 6 lines above this hunk@@ -7,8 +7,8 @@ interface Converter
7	7	/**
8	8	* Converts text to speech.
9	9	*
10		- * @param string $text
11		- * @param array $options
	10	+ * @param string $text
	11	+ * @param array $options
12	12	* @return mixed
13	13	*/
14	14	public function convert(string $text, array $options = null);
		⋯1 lineShow the 1 line above this hunk@@ -16,7 +16,7 @@ interface Converter
16	16	/**
17	17	* Set where to store the converted file.
18	18	*
19		- * @param string $disk
	19	+ * @param string $disk
20	20	* @return $this
21	21	*/
22	22	public function disk(string $disk);
		⋯1 lineShow the 1 line above this hunk@@ -24,7 +24,7 @@ interface Converter
24	24	/**
25	25	* Set path to where to save the converted file.
26	26	*
27		- * @param string $path
	27	+ * @param string $path
28	28	* @return $this
29	29	*/
30	30	public function saveTo(string $path);
		⋯1 lineShow the 1 line above this hunk@@ -32,7 +32,7 @@ interface Converter
32	32	/**
33	33	* Sets the source where the text from.
34	34	*
35		- * @param string $source
	35	+ * @param string $source
36	36	* @return $this
37	37	*/
38	38	public function source(string $source);
		⋯1 lineShow the 1 line above this hunk@@ -40,7 +40,7 @@ interface Converter
40	40	/**
41	41	* Sets the language to be used.
42	42	*
43		- * @param string $language
	43	+ * @param string $language
44	44	* @return $this
45	45	*/
46	46	public function language(string $language);

src/Contracts/Formatter.phpmodified+2-3

Changes to src/Contracts/Formatter.php

		⋯6 linesShow the 6 lines above this hunk@@ -7,9 +7,8 @@ interface Formatter
7	7	/**
8	8	* Handles the filename of the audio.
9	9	*
10		- * @param string $text The text source
11		- * @param mixed $audio The result audio content.
12		- *
	10	+ * @param string $text The text source
	11	+ * @param mixed $audio The result audio content.
13	12	* @return string
14	13	*/
15	14	public function handle($text, $audio = null): string;

src/Contracts/Source.phpmodifiedformatting only+1-1

Changes to src/Contracts/Source.php

		⋯6 linesShow the 6 lines above this hunk@@ -7,7 +7,7 @@ interface Source
7	7	/**
8	8	* Handles in getting the text from source.
9	9	*
10		- * @param string $data
	10	+ * @param string $data
11	11	* @return string
12	12	*/
13	13	public function handle(string $data): string;

src/Converters/NullConverter.phpmodifiedformatting only+2-2

Changes to src/Converters/NullConverter.php

		⋯14 linesShow the 14 lines above this hunk@@ -15,8 +15,8 @@ class NullConverter implements Converter
15	15	/**
16	16	* Converts the text to speech.
17	17	*
18		- * @param mixed $data
19		- * @param array $options
	18	+ * @param mixed $data
	19	+ * @param array $options
20	20	* @return void
21	21	*/
22	22	public function convert($data, array $options = null)

src/Converters/PollyConverter.phpmodifiedformatting only+13-13

Changes to src/Converters/PollyConverter.php

		⋯25 linesShow the 25 lines above this hunk@@ -26,7 +26,7 @@ class PollyConverter implements Converter
26	26	/**
27	27	* Construct converter.
28	28	*
29		- * @param PollyClient $client
	29	+ * @param PollyClient $client
30	30	*/
31	31	public function __construct(PollyClient $client)
32	32	{
		⋯13 linesShow the 13 lines above this hunk@@ -46,8 +46,8 @@ class PollyConverter implements Converter
46	46	/**
47	47	* Converts the text to speech.
48	48	*
49		- * @param string $data
50		- * @param array $options
	49	+ * @param string $data
	50	+ * @param array $options
51	51	* @return string|array
52	52	*/
53	53	public function convert(string $data, array $options = null)
		⋯27 linesShow the 27 lines above this hunk@@ -81,8 +81,8 @@ class PollyConverter implements Converter
81	81	/**
82	82	* Request to Amazon Polly to synthesize speech.
83	83	*
84		- * @param string|array $text
85		- * @param array $options
	84	+ * @param string|array $text
	85	+ * @param array $options
86	86	* @return array|\Aws\Result
87	87	*/
88	88	protected function synthesizeSpeech($text, array $options = null)
		⋯46 linesShow the 46 lines above this hunk@@ -135,7 +135,7 @@ class PollyConverter implements Converter
135	135	/**
136	136	* Checks the length of the text if more than 3000.
137	137	*
138		- * @param string $text
	138	+ * @param string $text
139	139	* @return bool
140	140	*/
141	141	protected function isTextAboveLimit(string $text)
		⋯4 linesShow the 4 lines above this hunk@@ -146,8 +146,8 @@ class PollyConverter implements Converter
146	146	/**
147	147	* Chunk the given text into array.
148	148	*
149		- * @param string $text
150		- * @param int $size
	149	+ * @param string $text
	150	+ * @param int $size
151	151	* @return array
152	152	*/
153	153	protected function getChunkText(string $text, int $size = 2000)
		⋯4 linesShow the 4 lines above this hunk@@ -158,7 +158,7 @@ class PollyConverter implements Converter
158	158	/**
159	159	* Get the text to speech voice ID.
160	160	*
161		- * @param array $options
	161	+ * @param array $options
162	162	* @return string
163	163	*/
164	164	protected function voice($options)
		⋯28 linesShow the 28 lines above this hunk@@ -193,7 +193,7 @@ class PollyConverter implements Converter
193	193	/**
194	194	* Get the audio format.
195	195	*
196		- * @param array $options
	196	+ * @param array $options
197	197	* @return string
198	198	*/
199	199	protected function format($options)
		⋯10 linesShow the 10 lines above this hunk@@ -210,7 +210,7 @@ class PollyConverter implements Converter
210	210	/**
211	211	* Get the engine.
212	212	*
213		- * @param array $options
	213	+ * @param array $options
214	214	* @return string
215	215	*/
216	216	protected function engine($options)
		⋯16 linesShow the 16 lines above this hunk@@ -233,7 +233,7 @@ class PollyConverter implements Converter
233	233	/**
234	234	* Get the content of the result from AWS Polly.
235	235	*
236		- * @param Result $result
	236	+ * @param Result $result
237	237	* @return mixed
238	238	*/
239	239	protected function getResultContent($result)
		⋯14 linesShow the 14 lines above this hunk@@ -254,7 +254,7 @@ class PollyConverter implements Converter
254	254	/**
255	255	* Format the given json string into an array.
256	256	*
257		- * @param string $json
	257	+ * @param string $json
258	258	* @return array
259	259	*/
260	260	protected function formatToArray($json)

src/Formatters/DefaultFilenameFormatter.phpmodified+2-3

Changes to src/Formatters/DefaultFilenameFormatter.php

		⋯8 linesShow the 8 lines above this hunk@@ -9,9 +9,8 @@ class DefaultFilenameFormatter implements FormatterContract
9	9	/**
10	10	* Handles the filename of the audio.
11	11	*
12		- * @param string $text The text source.
13		- * @param mixed $audio The result audio content.
14		- *
	12	+ * @param string $text The text source.
	13	+ * @param mixed $audio The result audio content.
15	14	* @return string
16	15	*/
17	16	public function handle($text, $audio = null): string

src/Sources/PathSource.phpmodifiedformatting only+1-1

Changes to src/Sources/PathSource.php

		⋯8 linesShow the 8 lines above this hunk@@ -9,7 +9,7 @@ class PathSource implements SourceContract
9	9	/**
10	10	* Handles in getting the text from source.
11	11	*
12		- * @param string $data
	12	+ * @param string $data
13	13	* @return string
14	14	*/
15	15	public function handle(string $data): string

src/Sources/RecursiveDOMIterator.phpmodified+10-1

Changes to src/Sources/RecursiveDOMIterator.php

		⋯8 linesShow the 8 lines above this hunk@@ -9,18 +9,20 @@ class RecursiveDOMIterator implements RecursiveIterator
9	9	{
10	10	/**
11	11	* Current Position in DOMNodeList.
	12	+ *
12	13	* @var int
13	14	*/
14	15	protected $_position;
15	16
16	17	/**
17	18	* The DOMNodeList with all children to iterate over.
	19	+ *
18	20	* @var DOMNodeList
19	21	*/
20	22	protected $_nodeList;
21	23
22	24	/**
23		- * @param DOMNode $domNode
	25	+ * @param DOMNode $domNode
24	26	*/
25	27	public function __construct(DOMNode $domNode)
26	28	{
		⋯3 linesShow the 3 lines above this hunk@@ -30,6 +32,7 @@ class RecursiveDOMIterator implements RecursiveIterator
30	32
31	33	/**
32	34	* Returns the current DOMNode.
	35	+ *
33	36	* @return DOMNode
34	37	*/
35	38	public function current()
		⋯3 linesShow the 3 lines above this hunk@@ -39,6 +42,7 @@ class RecursiveDOMIterator implements RecursiveIterator
39	42
40	43	/**
41	44	* Returns an iterator for the current iterator entry.
	45	+ *
42	46	* @return RecursiveDOMIterator
43	47	*/
44	48	public function getChildren()
		⋯3 linesShow the 3 lines above this hunk@@ -48,6 +52,7 @@ class RecursiveDOMIterator implements RecursiveIterator
48	52
49	53	/**
50	54	* Returns if an iterator can be created for the current entry.
	55	+ *
51	56	* @return bool
52	57	*/
53	58	public function hasChildren()
		⋯3 linesShow the 3 lines above this hunk@@ -57,6 +62,7 @@ class RecursiveDOMIterator implements RecursiveIterator
57	62
58	63	/**
59	64	* Returns the current position.
	65	+ *
60	66	* @return int
61	67	*/
62	68	public function key()
		⋯3 linesShow the 3 lines above this hunk@@ -66,6 +72,7 @@ class RecursiveDOMIterator implements RecursiveIterator
66	72
67	73	/**
68	74	* Moves the current position to the next element.
	75	+ *
69	76	* @return void
70	77	*/
71	78	public function next()
		⋯3 linesShow the 3 lines above this hunk@@ -75,6 +82,7 @@ class RecursiveDOMIterator implements RecursiveIterator
75	82
76	83	/**
77	84	* Rewind the Iterator to the first element.
	85	+ *
78	86	* @return void
79	87	*/
80	88	public function rewind()
		⋯3 linesShow the 3 lines above this hunk@@ -84,6 +92,7 @@ class RecursiveDOMIterator implements RecursiveIterator
84	92
85	93	/**
86	94	* Checks if current position is valid.
	95	+ *
87	96	* @return bool
88	97	*/
89	98	public function valid()

src/Sources/TextSource.phpmodifiedformatting only+1-1

Changes to src/Sources/TextSource.php

		⋯8 linesShow the 8 lines above this hunk@@ -9,7 +9,7 @@ class TextSource implements SourceContract
9	9	/**
10	10	* Handles in getting the text from source.
11	11	*
12		- * @param string $data
	12	+ * @param string $data
13	13	* @return string
14	14	*/
15	15	public function handle(string $data): string

src/Sources/WebsiteSource.phpmodifiedformatting only+2-2

Changes to src/Sources/WebsiteSource.php

		⋯11 linesShow the 11 lines above this hunk@@ -12,7 +12,7 @@ class WebsiteSource implements SourceContract
12	12	/**
13	13	* Handles in getting the text from source.
14	14	*
15		- * @param string $data
	15	+ * @param string $data
16	16	* @return string
17	17	*/
18	18	public function handle(string $data): string
		⋯26 linesShow the 26 lines above this hunk@@ -45,7 +45,7 @@ class WebsiteSource implements SourceContract
45	45	/**
46	46	* Get text from the articles DOM Node List.
47	47	*
48		- * @param DOMNodeList $articles
	48	+ * @param DOMNodeList $articles
49	49	* @return string
50	50	*/
51	51	protected function getTextFromArticle(DOMNodeList $articles): string

src/TextToSpeechManager.phpmodifiedformatting only+3-3

Changes to src/TextToSpeechManager.php

		⋯44 linesShow the 44 lines above this hunk@@ -45,8 +45,8 @@ class TextToSpeechManager extends Manager
45	45	/**
46	46	* Sets the polly client.
47	47	*
48		- * @param array $config
49		- * @param Credentials $credentials
	48	+ * @param array $config
	49	+ * @param Credentials $credentials
50	50	* @return PollyClient
51	51	*/
52	52	protected function setPollyClient(array $config, Credentials $credentials)
		⋯8 linesShow the 8 lines above this hunk@@ -61,7 +61,7 @@ class TextToSpeechManager extends Manager
61	61	/**
62	62	* Get credentials of AWS.
63	63	*
64		- * @param array $credentials
	64	+ * @param array $credentials
65	65	* @return \Aws\Credentials\Credentials
66	66	*/
67	67	protected function getCredentials(array $credentials)

src/Traits/HasLanguage.phpmodifiedformatting only+1-1

Changes to src/Traits/HasLanguage.php

		⋯11 linesShow the 11 lines above this hunk@@ -12,7 +12,7 @@ trait HasLanguage
12	12	/**
13	13	* Sets the language to be used.
14	14	*
15		- * @param string $language
	15	+ * @param string $language
16	16	* @return $this
17	17	*/
18	18	public function language(string $language)

src/Traits/HasSpeechMarks.phpmodifiedformatting only+1-1

Changes to src/Traits/HasSpeechMarks.php

		⋯11 linesShow the 11 lines above this hunk@@ -12,7 +12,7 @@ trait HasSpeechMarks
12	12	/**
13	13	* Sets the speech mark types.
14	14	*
15		- * @param array $speechMarks
	15	+ * @param array $speechMarks
16	16	* @return $this
17	17	*/
18	18	public function speechMarks(array $speechMarks)

src/Traits/Sourceable.phpmodified+3-2

formatting only · 8 hidden lines

Changes to src/Traits/Sourceable.php

		@@ -16,7 +16,7 @@ trait Sourceable formatting only
16	16	/**
17	17	* Sets the source.
18	18	*
19		- * @param string $source
	19	+ * @param string $source
20	20	* @return $this
21	21	*/
22	22	public function source(string $source)

Changes to src/Traits/Sourceable.php

		@@ -28,7 +28,8 @@ trait Sourceable
28	28
29	29	/**
30	30	* Get text from source.
31		- * @param string $data
	31	+ *
	32	+ * @param string $data
32	33	* @return string
33	34	*/
34	35	protected function getTextFromSource(string $data): string

src/Traits/Storable.phpmodified+8-13

Changes to src/Traits/Storable.php

		⋯23 linesShow the 23 lines above this hunk@@ -24,8 +24,7 @@ trait Storable
24	24	/**
25	25	* Set where to store the converted file.
26	26	*
27		- * @param string $disk
28		- *
	27	+ * @param string $disk
29	28	* @return $this
30	29	*/
31	30	public function disk(string $disk)
		⋯6 linesShow the 6 lines above this hunk@@ -38,8 +37,7 @@ trait Storable
38	37	/**
39	38	* Set path to where to store the converted file.
40	39	*
41		- * @param string $path
42		- *
	40	+ * @param string $path
43	41	* @return $this
44	42	*/
45	43	public function saveTo(string $path)
		⋯6 linesShow the 6 lines above this hunk@@ -52,9 +50,8 @@ trait Storable
52	50	/**
53	51	* Execute the store.
54	52	*
55		- * @param string $text
56		- * @param mixed $resultContent
57		- *
	53	+ * @param string $text
	54	+ * @param mixed $resultContent
58	55	* @return string
59	56	*/
60	57	protected function store($text, $resultContent)
		⋯10 linesShow the 10 lines above this hunk@@ -71,9 +68,8 @@ trait Storable
71	68	/**
72	69	* Ensures the path not to be null if it is null it will set a default path.
73	70	*
74		- * @param string $text
75		- * @param mixed $audio
76		- *
	71	+ * @param string $text
	72	+ * @param mixed $audio
77	73	* @return void
78	74	*/
79	75	protected function ensurePathIsNotNull($text, $audio)
		⋯31 linesShow the 31 lines above this hunk@@ -111,9 +107,8 @@ trait Storable
111	107	/**
112	108	* Get default filename returned in Filename Formatter.
113	109	*
114		- * @param string $text
115		- * @param mixed $audio
116		- *
	110	+ * @param string $text
	111	+ * @param mixed $audio
117	112	* @return string
118	113	*/
119	114	protected function getDefaultFilename($text, $audio)