coding style: TRUE/FALSE/NULL -> true/false/null

dg · dg · commit 0ca0229676e8 · 2017-07-21T21:59:36.000+02:00
diff --git a/readme.md b/readme.md
@@ -58,7 +58,7 @@ $mail->setHTMLBody('<b>Sample HTML</b> <img src="background.gif">');
 
 Embedded images can be inserted using `$mail->addEmbeddedFile('background.gif')`, but it is not necessary.
 Why? Because Nette Framework finds and inserts all files referenced in the HTML code automatically.
-This behavior can be supressed by adding `FALSE` as a second parameter of the `setHtmlBody()` method.
+This behavior can be supressed by adding `false` as a second parameter of the `setHtmlBody()` method.
 
 If a HTML e-mail has no plain-text alternative, it will be automatically generated. And if it has no subject set, it will be taken from the `<title>` element.
 
diff --git a/src/Bridges/MailDI/MailExtension.php b/src/Bridges/MailDI/MailExtension.php
@@ -18,14 +18,14 @@
 class MailExtension extends Nette\DI\CompilerExtension
 {
 	public $defaults = [
-		'smtp' => FALSE,
-		'host' => NULL,
-		'port' => NULL,
-		'username' => NULL,
-		'password' => NULL,
-		'secure' => NULL,
-		'timeout' => NULL,
-		'context'  => NULL,
+		'smtp' => false,
+		'host' => null,
+		'port' => null,
+		'username' => null,
+		'password' => null,
+		'secure' => null,
+		'timeout' => null,
+		'context'  => null,
 	];
 
 
diff --git a/src/Mail/Message.php b/src/Mail/Message.php
@@ -55,7 +55,7 @@ public function __construct()
 	 * Sets the sender of the message. Email or format "John Doe" <doe@example.com>
 	 * @return static
 	 */
-	public function setFrom(string $email, string $name = NULL)
+	public function setFrom(string $email, string $name = null)
 	{
 		$this->setHeader('From', $this->formatEmail($email, $name));
 		return $this;
@@ -75,9 +75,9 @@ public function getFrom(): array
 	 * Adds the reply-to address. Email or format "John Doe" <doe@example.com>
 	 * @return static
 	 */
-	public function addReplyTo(string $email, string $name = NULL)
+	public function addReplyTo(string $email, string $name = null)
 	{
-		$this->setHeader('Reply-To', $this->formatEmail($email, $name), TRUE);
+		$this->setHeader('Reply-To', $this->formatEmail($email, $name), true);
 		return $this;
 	}
 
@@ -106,9 +106,9 @@ public function getSubject(): ?string
 	 * Adds email recipient. Email or format "John Doe" <doe@example.com>
 	 * @return static
 	 */
-	public function addTo(string $email, string $name = NULL) // addRecipient()
+	public function addTo(string $email, string $name = null) // addRecipient()
 	{
-		$this->setHeader('To', $this->formatEmail($email, $name), TRUE);
+		$this->setHeader('To', $this->formatEmail($email, $name), true);
 		return $this;
 	}
 
@@ -117,9 +117,9 @@ public function addTo(string $email, string $name = NULL) // addRecipient()
 	 * Adds carbon copy email recipient. Email or format "John Doe" <doe@example.com>
 	 * @return static
 	 */
-	public function addCc(string $email, string $name = NULL)
+	public function addCc(string $email, string $name = null)
 	{
-		$this->setHeader('Cc', $this->formatEmail($email, $name), TRUE);
+		$this->setHeader('Cc', $this->formatEmail($email, $name), true);
 		return $this;
 	}
 
@@ -128,17 +128,17 @@ public function addCc(string $email, string $name = NULL)
 	 * Adds blind carbon copy email recipient. Email or format "John Doe" <doe@example.com>
 	 * @return static
 	 */
-	public function addBcc(string $email, string $name = NULL)
+	public function addBcc(string $email, string $name = null)
 	{
-		$this->setHeader('Bcc', $this->formatEmail($email, $name), TRUE);
+		$this->setHeader('Bcc', $this->formatEmail($email, $name), true);
 		return $this;
 	}
 
 
 	/**
 	 * Formats recipient email.
 	 */
-	private function formatEmail(string $email, string $name = NULL): array
+	private function formatEmail(string $email, string $name = null): array
 	{
 		if (!$name && preg_match('#^(.+) +<(.*)>\z#', $email, $matches)) {
 			return [$matches[2] => $matches[1]];
@@ -192,7 +192,7 @@ public function getPriority(): int
 	 * Sets HTML body.
 	 * @return static
 	 */
-	public function setHtmlBody(string $html, string $basePath = NULL)
+	public function setHtmlBody(string $html, string $basePath = null)
 	{
 		if ($basePath) {
 			$cids = [];
@@ -220,7 +220,7 @@ public function setHtmlBody(string $html, string $basePath = NULL)
 			}
 		}
 
-		if ($this->getSubject() == NULL) { // intentionally ==
+		if ($this->getSubject() == null) { // intentionally ==
 			$html = Strings::replace($html, '#<title>(.+?)</title>#is', function ($m) {
 				$this->setSubject(html_entity_decode($m[1], ENT_QUOTES, 'UTF-8'));
 			});
@@ -248,7 +248,7 @@ public function getHtmlBody(): string
 	/**
 	 * Adds embedded file.
 	 */
-	public function addEmbeddedFile(string $file, string $content = NULL, string $contentType = NULL): MimePart
+	public function addEmbeddedFile(string $file, string $content = null, string $contentType = null): MimePart
 	{
 		return $this->inlines[$file] = $this->createAttachment($file, $content, $contentType, 'inline')
 			->setHeader('Content-ID', $this->getRandomId());
@@ -269,7 +269,7 @@ public function addInlinePart(MimePart $part)
 	/**
 	 * Adds attachment.
 	 */
-	public function addAttachment(string $file, string $content = NULL, string $contentType = NULL): MimePart
+	public function addAttachment(string $file, string $content = null, string $contentType = null): MimePart
 	{
 		return $this->attachments[] = $this->createAttachment($file, $content, $contentType, 'attachment');
 	}
@@ -288,12 +288,12 @@ public function getAttachments(): array
 	/**
 	 * Creates file MIME part.
 	 */
-	private function createAttachment(string $file, string $content = NULL, string $contentType = NULL, string $disposition): MimePart
+	private function createAttachment(string $file, string $content = null, string $contentType = null, string $disposition): MimePart
 	{
 		$part = new MimePart;
-		if ($content === NULL) {
+		if ($content === null) {
 			$content = @file_get_contents($file); // @ is escalated to exception
-			if ($content === FALSE) {
+			if ($content === false) {
 				throw new Nette\FileNotFoundException("Unable to read file '$file'.");
 			}
 		}
diff --git a/src/Mail/MimePart.php b/src/Mail/MimePart.php
@@ -47,13 +47,13 @@ class MimePart
 	 * @param  string|array $value  value or pair email => name
 	 * @return static
 	 */
-	public function setHeader(string $name, $value, bool $append = FALSE)
+	public function setHeader(string $name, $value, bool $append = false)
 	{
 		if (!$name || preg_match('#[^a-z0-9-]#i', $name)) {
 			throw new Nette\InvalidArgumentException("Header name must be non-empty alphanumeric string, '$name' given.");
 		}
 
-		if ($value == NULL) { // intentionally ==
+		if ($value == null) { // intentionally ==
 			if (!$append) {
 				unset($this->headers[$name]);
 			}
@@ -65,7 +65,7 @@ public function setHeader(string $name, $value, bool $append = FALSE)
 			}
 
 			foreach ($value as $email => $recipient) {
-				if ($recipient === NULL) {
+				if ($recipient === null) {
 					// continue
 				} elseif (!Strings::checkEncoding($recipient)) {
 					Nette\Utils\Validators::assert($recipient, 'unicode', "header '$name'");
@@ -93,7 +93,7 @@ public function setHeader(string $name, $value, bool $append = FALSE)
 	 */
 	public function getHeader(string $name)
 	{
-		return $this->headers[$name] ?? NULL;
+		return $this->headers[$name] ?? null;
 	}
 
 
@@ -116,13 +116,13 @@ public function getEncodedHeader(string $name): ?string
 		$offset = strlen($name) + 2; // colon + space
 
 		if (!isset($this->headers[$name])) {
-			return NULL;
+			return null;
 
 		} elseif (is_array($this->headers[$name])) {
 			$s = '';
 			foreach ($this->headers[$name] as $email => $name) {
-				if ($name != NULL) { // intentionally ==
-					$s .= self::encodeHeader($name, $offset, TRUE);
+				if ($name != null) { // intentionally ==
+					$s .= self::encodeHeader($name, $offset, true);
 					$email = " <$email>";
 				}
 				$s .= self::append($email . ',', $offset);
@@ -152,7 +152,7 @@ public function getHeaders(): array
 	 * Sets Content-Type header.
 	 * @return static
 	 */
-	public function setContentType(string $contentType, string $charset = NULL)
+	public function setContentType(string $contentType, string $charset = null)
 	{
 		$this->setHeader('Content-Type', $contentType . ($charset ? "; charset=$charset" : ''));
 		return $this;
@@ -182,9 +182,9 @@ public function getEncoding(): string
 	/**
 	 * Adds or creates new multipart.
 	 */
-	public function addPart(MimePart $part = NULL): self
+	public function addPart(MimePart $part = null): self
 	{
-		return $this->parts[] = $part === NULL ? new self : $part;
+		return $this->parts[] = $part === null ? new self : $part;
 	}
 
 
@@ -274,7 +274,7 @@ public function getEncodedMessage(): string
 	/**
 	 * Converts a 8 bit header to a string.
 	 */
-	private static function encodeHeader(string $s, int &$offset = 0, bool $quotes = FALSE): string
+	private static function encodeHeader(string $s, int &$offset = 0, bool $quotes = false): string
 	{
 		if (strspn($s, "!\"#$%&\'()*+,-./0123456789:;<>@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^`abcdefghijklmnopqrstuvwxyz{|}~=? _\r\n\t") === strlen($s)) {
 			if ($quotes && preg_match('#[^ a-zA-Z0-9!\#$%&\'*+/?^_`{|}~-]#', $s)) { // RFC 2822 atext except =
diff --git a/src/Mail/SendmailMailer.php b/src/Mail/SendmailMailer.php
@@ -19,7 +19,7 @@ class SendmailMailer implements IMailer
 {
 	use Nette\SmartObject;
 
-	/** @var string|NULL */
+	/** @var string|null */
 	public $commandArgs;
 
 
@@ -30,8 +30,8 @@ class SendmailMailer implements IMailer
 	public function send(Message $mail): void
 	{
 		$tmp = clone $mail;
-		$tmp->setHeader('Subject', NULL);
-		$tmp->setHeader('To', NULL);
+		$tmp->setHeader('Subject', null);
+		$tmp->setHeader('To', null);
 
 		$parts = explode(Message::EOL . Message::EOL, $tmp->generateMessage(), 2);
 
@@ -47,7 +47,7 @@ public function send(Message $mail): void
 		$res = Nette\Utils\Callback::invokeSafe('mail', $args, function ($message) use (&$info) {
 			$info = ": $message";
 		});
-		if ($res === FALSE) {
+		if ($res === false) {
 			throw new SendException("Unable to send email$info.");
 		}
 	}
diff --git a/src/Mail/SmtpMailer.php b/src/Mail/SmtpMailer.php
@@ -51,7 +51,7 @@ public function __construct(array $options = [])
 	{
 		if (isset($options['host'])) {
 			$this->host = $options['host'];
-			$this->port = isset($options['port']) ? (int) $options['port'] : NULL;
+			$this->port = isset($options['port']) ? (int) $options['port'] : null;
 		} else {
 			$this->host = ini_get('SMTP');
 			$this->port = (int) ini_get('smtp_port');
@@ -95,7 +95,7 @@ public function send(Message $mail): void
 				$this->write("RCPT TO:<$email>", [250, 251]);
 			}
 
-			$mail->setHeader('Bcc', NULL);
+			$mail->setHeader('Bcc', null);
 			$data = $mail->generateMessage();
 			$this->write('DATA', 354);
 			$data = preg_replace('#^\.#m', '..', $data);
@@ -139,19 +139,19 @@ protected function connect(): void
 
 		if ($this->secure === 'tls') {
 			$this->write('STARTTLS', 220);
-			if (!stream_socket_enable_crypto($this->connection, TRUE, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
+			if (!stream_socket_enable_crypto($this->connection, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
 				throw new SmtpException('Unable to connect via TLS.');
 			}
 			$this->write("EHLO $self", 250);
 		}
 
-		if ($this->username != NULL && $this->password != NULL) {
+		if ($this->username != null && $this->password != null) {
 			$authMechanisms = [];
 			if (preg_match('~^250[ -]AUTH (.*)$~im', $ehloResponse, $matches)) {
 				$authMechanisms = explode(' ', trim($matches[1]));
 			}
 
-			if (in_array('PLAIN', $authMechanisms, TRUE)) {
+			if (in_array('PLAIN', $authMechanisms, true)) {
 				$credentials = $this->username . "\0" . $this->username . "\0" . $this->password;
 				$this->write('AUTH PLAIN ' . base64_encode($credentials), 235, 'PLAIN credentials');
 			} else {
@@ -169,20 +169,20 @@ protected function connect(): void
 	protected function disconnect(): void
 	{
 		fclose($this->connection);
-		$this->connection = NULL;
+		$this->connection = null;
 	}
 
 
 	/**
 	 * Writes data to server and checks response against expected code if some provided.
 	 * @param  int|int[] $expectedCode
 	 */
-	protected function write(string $line, $expectedCode = NULL, string $message = NULL): void
+	protected function write(string $line, $expectedCode = null, string $message = null): void
 	{
 		fwrite($this->connection, $line . Message::EOL);
 		if ($expectedCode) {
 			$response = $this->read();
-			if (!in_array((int) $response, (array) $expectedCode, TRUE)) {
+			if (!in_array((int) $response, (array) $expectedCode, true)) {
 				throw new SmtpException('SMTP server did not accept ' . ($message ? $message : $line) . ' with error: ' . trim($response));
 			}
 		}
@@ -195,7 +195,7 @@ protected function write(string $line, $expectedCode = NULL, string $message = N
 	protected function read(): string
 	{
 		$s = '';
-		while (($line = fgets($this->connection, 1000)) != NULL) { // intentionally ==
+		while (($line = fgets($this->connection, 1000)) != null) { // intentionally ==
 			$s .= $line;
 			if (substr($line, 3, 1) === ' ') {
 				break;
diff --git a/tests/Mail.DI/include.php b/tests/Mail.DI/include.php
@@ -7,7 +7,7 @@ class FooExtension extends Nette\DI\CompilerExtension
 }
 
 
-function createContainer($source, $config = NULL)
+function createContainer($source, $config = null)
 {
 	$loader = new Nette\DI\Config\Loader;
 	$config = $loader->load(Tester\FileMock::create($config, 'neon'));
diff --git a/tests/Mail/Mail.attachment.phpt b/tests/Mail/Mail.attachment.phpt
@@ -18,7 +18,7 @@ require __DIR__ . '/Mail.php';
 $mailer = new TestMailer();
 
 $mail = new Message();
-$mail->addAttachment(__DIR__ . '/files/example.zip', NULL, 'application/zip');
+$mail->addAttachment(__DIR__ . '/files/example.zip', null, 'application/zip');
 $mailer->send($mail);
 
 Assert::match(<<<EOD
@@ -49,7 +49,7 @@ EOD
 
 
 $mail = new Message();
-$mail->addAttachment(__DIR__ . '/files/example.zip', NULL, 'application/zip')
+$mail->addAttachment(__DIR__ . '/files/example.zip', null, 'application/zip')
 	->setEncoding(Message::ENCODING_QUOTED_PRINTABLE);
 $mailer->send($mail);
 
diff --git a/tests/Mail/Mail.textualAndHtmlBody.attachment.phpt b/tests/Mail/Mail.textualAndHtmlBody.attachment.phpt
@@ -25,7 +25,7 @@ $mail->setBody('Sample text');
 
 $mail->setHTMLBody('<b>Sample text</b>');
 
-$mail->addAttachment(__DIR__ . '/files/example.zip', NULL, 'application/zip');
+$mail->addAttachment(__DIR__ . '/files/example.zip', null, 'application/zip');
 
 $mailer = new TestMailer();
 $mailer->send($mail);
diff --git a/tests/Mail/Mail.textualBody.attachment.phpt b/tests/Mail/Mail.textualBody.attachment.phpt
@@ -23,7 +23,7 @@ $mail->setSubject('Hello Jane!');
 
 $mail->setBody('Sample text');
 
-$mail->addAttachment(__DIR__ . '/files/example.zip', NULL, 'application/zip');
+$mail->addAttachment(__DIR__ . '/files/example.zip', null, 'application/zip');
 
 $mailer = new TestMailer();
 $mailer->send($mail);

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class SendmailMailer implements IMailer`
`19`	`19`	`{`
`20`	`20`	`use Nette\SmartObject;`
`21`	`21`
`22`		`- /** @var string\|NULL */`
	`22`	`+ /** @var string\|null */`
`23`	`23`	`public $commandArgs;`
`24`	`24`
`25`	`25`
`@@ -30,8 +30,8 @@ class SendmailMailer implements IMailer`
`30`	`30`	`public function send(Message $mail): void`
`31`	`31`	`{`
`32`	`32`	`$tmp = clone $mail;`
`33`		`- $tmp->setHeader('Subject', NULL);`
`34`		`- $tmp->setHeader('To', NULL);`
	`33`	`+ $tmp->setHeader('Subject', null);`
	`34`	`+ $tmp->setHeader('To', null);`
`35`	`35`
`36`	`36`	`$parts = explode(Message::EOL . Message::EOL, $tmp->generateMessage(), 2);`
`37`	`37`
`@@ -47,7 +47,7 @@ public function send(Message $mail): void`
`47`	`47`	`$res = Nette\Utils\Callback::invokeSafe('mail', $args, function ($message) use (&$info) {`
`48`	`48`	`$info = ": $message";`
`49`	`49`	`});`
`50`		`- if ($res === FALSE) {`
	`50`	`+ if ($res === false) {`
`51`	`51`	`throw new SendException("Unable to send email$info.");`
`52`	`52`	`}`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ class FooExtension extends Nette\DI\CompilerExtension`
`7`	`7`	`}`
`8`	`8`
`9`	`9`
`10`		`-function createContainer($source, $config = NULL)`
	`10`	`+function createContainer($source, $config = null)`
`11`	`11`	`{`
`12`	`12`	`$loader = new Nette\DI\Config\Loader;`
`13`	`13`	`$config = $loader->load(Tester\FileMock::create($config, 'neon'));`