jacobemerick / archangel

Archangel.class.php

Doc Comments +13 added lines, -10 removed lines

@@ -60,7 +60,7 @@ 
 	 *
 	 * @param	string	$address	email address for the recipient
 	 * @param	string	$title		name of the recipient (optional)
-	 * @return	object	instantiated $this
+	 * @return	Archangel	instantiated $this
 	 */
 	public function addTo($address, $title = '')
 	{
@@ -75,7 +75,7 @@ 
 	 *
 	 * @param	string	$address	email address for the cc recipient
 	 * @param	string	$title		name of the cc recipient (optional)
-	 * @return	object	instantiated $this
+	 * @return	Archangel	instantiated $this
 	 */
 	public function addCC($address, $title = '')
 	{
@@ -90,7 +90,7 @@ 
 	 *
 	 * @param	string	$address	email address for the bcc recipient
 	 * @param	string	$title		name of the bcc recipient (optional)
-	 * @return	object	instantiated $this
+	 * @return	Archangel	instantiated $this
 	 */
 	public function addBCC($address, $title = '')
 	{
@@ -105,7 +105,7 @@ 
 	 *
 	 * @param	string	$address	email address for the sender
 	 * @param	string	$title		name of the sender (optional)
-	 * @return	object	instantiated $this
+	 * @return	Archangel	instantiated $this
 	 */
 	public function setFrom($address, $title = '')
 	{
@@ -120,7 +120,7 @@ 
 	 *
 	 * @param	string	$address	email address for the reply-to
 	 * @param	string	$title		name of the reply-to (optional)
-	 * @return	object	instantiated $this
+	 * @return	Archangel	instantiated $this
 	 */
 	public function setReplyTo($address, $title = '')
 	{
@@ -134,7 +134,7 @@ 
 	 * Setter method for setting a subject
 	 *
 	 * @param	string	$subject	subject for the email
-	 * @return	object	instantiated $this
+	 * @return	Archangel	instantiated $this
 	 */
 	public function setSubject($subject)
 	{
@@ -148,7 +148,7 @@ 
 	 * Setter method for the plain text message
 	 *
 	 * @param	string	$message	the plain-text message
-	 * @return	object	insantiated $this
+	 * @return	Archangel	insantiated $this
 	 */
 	public function setPlainMessage($message)
 	{
@@ -161,7 +161,7 @@ 
 	 * Setter method for the html message
 	 *
 	 * @param	string	$message	the html message
-	 * @return	object	insantiated $this
+	 * @return	Archangel	insantiated $this
 	 */
 	public function setHTMLMessage($message)
 	{
@@ -176,7 +176,7 @@ 
 	 * @param	string	$path	the full path of the attachment
 	 * @param	string	$type	mime type of the file
 	 * @param	string	$title	the title of the attachment (optional)
-	 * @return	object	insantiated $this
+	 * @return	Archangel	insantiated $this
 	 */
 	public function addAttachment($path, $type, $title = '')
 	{
@@ -214,7 +214,7 @@ 
 	/**
 	 * Main instantiator for the class
 	 *
-	 * @return	object	instantiated $this
+	 * @return	Archangel	instantiated $this
 	 */
 	public static function instance()
 	{
@@ -400,6 +400,7 @@ 
 
 	/**
 	 * stub for email address checking
+	 * @param string $string
 	 */
 	private function is_valid_email_address($string)
 	{
@@ -411,6 +412,7 @@ 
 
 	/**
 	 * stub for email title checking
+	 * @param string $string
 	 */
 	private function is_valid_email_title($string)
 	{
@@ -419,6 +421,7 @@ 
 
 	/**
 	 * stub for subject checking
+	 * @param string $string
 	 */
 	private function is_valid_subject($string)
 	{

Spacing +27 added lines, -27 removed lines

@@ -64,7 +64,7 @@ 
 	 */
 	public function addTo($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
+		if ($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
 			$this->to_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
 		
 		return $this;
@@ -79,7 +79,7 @@ 
 	 */
 	public function addCC($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
+		if ($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
 			$this->cc_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
 		
 		return $this;
@@ -94,7 +94,7 @@ 
 	 */
 	public function addBCC($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
+		if ($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
 			$this->bcc_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
 		
 		return $this;
@@ -109,7 +109,7 @@ 
 	 */
 	public function setFrom($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
+		if ($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
 			$this->header_array['From'] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
 		
 		return $this;
@@ -124,7 +124,7 @@ 
 	 */
 	public function setReplyTo($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
+		if ($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
 			$this->header_array['Reply-To'] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
 		
 		return $this;
@@ -138,7 +138,7 @@ 
 	 */
 	public function setSubject($subject)
 	{
-		if($this->is_valid_subject($subject))
+		if ($this->is_valid_subject($subject))
 			$this->subject = $subject;
 		
 		return $this;
@@ -197,10 +197,10 @@ 
 	 */
 	public function send()
 	{
-		if($this->passed_validation === FALSE)
+		if ($this->passed_validation === FALSE)
 			return false;
 		
-		if(!$this->check_required_fields())
+		if (!$this->check_required_fields())
 			return false;
 		
 		$to = $this->get_to();
@@ -256,14 +256,14 @@ 
 	{
 		$message = '';
 		
-		if(isset($this->attachment_array) && count($this->attachment_array) > 0)
+		if (isset($this->attachment_array) && count($this->attachment_array) > 0)
 			$message .= "--{$this->get_boundary()}" . self::$LINE_BREAK;
 		
-		if(
+		if (
 			isset($this->plain_message) && strlen($this->plain_message) > 0 &&
 			isset($this->html_message) && strlen($this->html_message) > 0)
 		{
-			if(isset($this->attachment_array) && count($this->attachment_array) > 0)
+			if (isset($this->attachment_array) && count($this->attachment_array) > 0)
 			{
 				$message .= "Content-Type: multipart/alternative; boundary={$this->get_alternative_boundary()}" . self::$LINE_BREAK;
 				$message .= self::$LINE_BREAK;
@@ -283,9 +283,9 @@ 
 			$message .= "--{$this->get_alternative_boundary()}--" . self::$LINE_BREAK;
 			$message .= self::$LINE_BREAK;
 		}
-		else if(isset($this->plain_message) && strlen($this->plain_message))
+		else if (isset($this->plain_message) && strlen($this->plain_message))
 		{
-			if(isset($this->attachment_array) && count($this->attachment_array) > 0)
+			if (isset($this->attachment_array) && count($this->attachment_array) > 0)
 			{
 				$message .= 'Content-Type: text/plain; charset="iso-8859"' . self::$LINE_BREAK;
 				$message .= 'Content-Transfer-Encoding: 7bit' . self::$LINE_BREAK;
@@ -294,9 +294,9 @@ 
 			$message .= $this->plain_message;
 			$message .= self::$LINE_BREAK;
 		}
-		else if(isset($this->html_message) && strlen($this->html_message))
+		else if (isset($this->html_message) && strlen($this->html_message))
 		{
-			if(isset($this->attachment_array) && count($this->attachment_array) > 0)
+			if (isset($this->attachment_array) && count($this->attachment_array) > 0)
 			{
 				$message .= 'Content-Type: text/html; charset="iso-8859-1"' . self::$LINE_BREAK;
 				$message .= 'Content-Transfer-Encoding: 7bit' . self::$LINE_BREAK;
@@ -305,9 +305,9 @@ 
 			$message .= $this->html_message;
 			$message .= self::$LINE_BREAK;
 		}
-		if(isset($this->attachment_array) && count($this->attachment_array) > 0)
+		if (isset($this->attachment_array) && count($this->attachment_array) > 0)
 		{
-			foreach($this->attachment_array as $attachment)
+			foreach ($this->attachment_array as $attachment)
 			{
 				$message .= "--{$this->get_boundary()}" . self::$LINE_BREAK;
 				$message .= "Content-Type: {$attachment->type}; name=\"{$attachment->title}\"" . self::$LINE_BREAK;
@@ -331,7 +331,7 @@ 
 	private $boundary;
 	private function get_boundary()
 	{
-		if(!isset($this->boundary))
+		if (!isset($this->boundary))
 			$this->boundary = sprintf(self::$BOUNDARY_FORMAT, md5(date('r', time()) . self::$BOUNDARY_SALT));
 		return $this->boundary;
 	}
@@ -345,7 +345,7 @@ 
 	private $alternative_boundary;
 	private function get_alternative_boundary()
 	{
-		if(!isset($this->alternative_boundary))
+		if (!isset($this->alternative_boundary))
 			$this->alternative_boundary = sprintf(self::$ALTERNATIVE_BOUNDARY_FORMAT, md5(date('r', time()) . self::$ALTERNATIVE_BOUNDARY_SALT));
 		return $this->alternative_boundary;
 	}
@@ -358,25 +358,25 @@ 
 	private function get_additional_headers()
 	{
 		$headers = '';
-		foreach($this->header_array as $key => $value)
+		foreach ($this->header_array as $key => $value)
 		{
 			$headers .= "{$key}: {$value}" . self::$LINE_BREAK;
 		}
 		
-		if(count($this->cc_array) > 0)
+		if (count($this->cc_array) > 0)
 			$headers .= 'CC: ' . implode(', ', $this->cc_array) . self::$LINE_BREAK;
-		if(count($this->bcc_array) > 0)
+		if (count($this->bcc_array) > 0)
 			$headers .= 'BCC: ' . implode(', ', $this->bcc_array) . self::$LINE_BREAK;
 		
-		if(isset($this->attachment_array) && count($this->attachment_array) > 0)
+		if (isset($this->attachment_array) && count($this->attachment_array) > 0)
 			$headers .= "Content-Type: multipart/mixed; boundary=\"{$this->get_boundary()}\"";
-		else if(
+		else if (
 			isset($this->plain_message) && strlen($this->plain_message) > 0 &&
 			isset($this->html_message) && strlen($this->html_message) > 0)
 		{
 			$headers .= "Content-Type: multipart/alternative; boundary=\"{$this->get_alternative_boundary()}\"";
 		}
-		else if(isset($this->html_message) && strlen($this->html_message) > 0)
+		else if (isset($this->html_message) && strlen($this->html_message) > 0)
 			$headers .= 'Content-type: text/html; charset="iso-8859-1"';
 		
 		return $headers;
@@ -403,7 +403,7 @@ 
 	 */
 	private function is_valid_email_address($string)
 	{
-		if(strlen($string) < 1)
+		if (strlen($string) < 1)
 			return $this->fail_validation("{$string} is an invalid email address!");
 		
 		return true;
@@ -422,7 +422,7 @@ 
 	 */
 	private function is_valid_subject($string)
 	{
-		if(strlen($string) < 1)
+		if (strlen($string) < 1)
 			return $this->fail_validation("{$string} is an invalid email subject!");
 		
 		return true;

Braces +52 added lines, -39 removed lines

@@ -64,8 +64,9 @@ 
 	 */
 	public function addTo($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
-			$this->to_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title)) {
+					$this->to_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		}
 		
 		return $this;
 	}
@@ -79,8 +80,9 @@ 
 	 */
 	public function addCC($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
-			$this->cc_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title)) {
+					$this->cc_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		}
 		
 		return $this;
 	}
@@ -94,8 +96,9 @@ 
 	 */
 	public function addBCC($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
-			$this->bcc_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title)) {
+					$this->bcc_array[] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		}
 		
 		return $this;
 	}
@@ -109,8 +112,9 @@ 
 	 */
 	public function setFrom($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
-			$this->header_array['From'] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title)) {
+					$this->header_array['From'] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		}
 		
 		return $this;
 	}
@@ -124,8 +128,9 @@ 
 	 */
 	public function setReplyTo($address, $title = '')
 	{
-		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title))
-			$this->header_array['Reply-To'] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		if($this->is_valid_email_address($address) && $this->is_valid_email_title($title)) {
+					$this->header_array['Reply-To'] = ($title != '') ? "\"{$title}\" <{$address}>" : "{$address}";
+		}
 		
 		return $this;
 	}
@@ -138,8 +143,9 @@ 
 	 */
 	public function setSubject($subject)
 	{
-		if($this->is_valid_subject($subject))
-			$this->subject = $subject;
+		if($this->is_valid_subject($subject)) {
+					$this->subject = $subject;
+		}
 		
 		return $this;
 	}
@@ -197,11 +203,13 @@ 
 	 */
 	public function send()
 	{
-		if($this->passed_validation === FALSE)
-			return false;
+		if($this->passed_validation === FALSE) {
+					return false;
+		}
 		
-		if(!$this->check_required_fields())
-			return false;
+		if(!$this->check_required_fields()) {
+					return false;
+		}
 		
 		$to = $this->get_to();
 		$subject = $this->subject;
@@ -256,8 +264,9 @@ 
 	{
 		$message = '';
 		
-		if(isset($this->attachment_array) && count($this->attachment_array) > 0)
-			$message .= "--{$this->get_boundary()}" . self::$LINE_BREAK;
+		if(isset($this->attachment_array) && count($this->attachment_array) > 0) {
+					$message .= "--{$this->get_boundary()}" . self::$LINE_BREAK;
+		}
 		
 		if(
 			isset($this->plain_message) && strlen($this->plain_message) > 0 &&
@@ -282,8 +291,7 @@ 
 			$message .= self::$LINE_BREAK;
 			$message .= "--{$this->get_alternative_boundary()}--" . self::$LINE_BREAK;
 			$message .= self::$LINE_BREAK;
-		}
-		else if(isset($this->plain_message) && strlen($this->plain_message))
+		} else if(isset($this->plain_message) && strlen($this->plain_message))
 		{
 			if(isset($this->attachment_array) && count($this->attachment_array) > 0)
 			{
@@ -293,8 +301,7 @@ 
 			}
 			$message .= $this->plain_message;
 			$message .= self::$LINE_BREAK;
-		}
-		else if(isset($this->html_message) && strlen($this->html_message))
+		} else if(isset($this->html_message) && strlen($this->html_message))
 		{
 			if(isset($this->attachment_array) && count($this->attachment_array) > 0)
 			{
@@ -331,8 +338,9 @@ 
 	private $boundary;
 	private function get_boundary()
 	{
-		if(!isset($this->boundary))
-			$this->boundary = sprintf(self::$BOUNDARY_FORMAT, md5(date('r', time()) . self::$BOUNDARY_SALT));
+		if(!isset($this->boundary)) {
+					$this->boundary = sprintf(self::$BOUNDARY_FORMAT, md5(date('r', time()) . self::$BOUNDARY_SALT));
+		}
 		return $this->boundary;
 	}
 
@@ -345,8 +353,9 @@ 
 	private $alternative_boundary;
 	private function get_alternative_boundary()
 	{
-		if(!isset($this->alternative_boundary))
-			$this->alternative_boundary = sprintf(self::$ALTERNATIVE_BOUNDARY_FORMAT, md5(date('r', time()) . self::$ALTERNATIVE_BOUNDARY_SALT));
+		if(!isset($this->alternative_boundary)) {
+					$this->alternative_boundary = sprintf(self::$ALTERNATIVE_BOUNDARY_FORMAT, md5(date('r', time()) . self::$ALTERNATIVE_BOUNDARY_SALT));
+		}
 		return $this->alternative_boundary;
 	}
 
@@ -363,21 +372,23 @@ 
 			$headers .= "{$key}: {$value}" . self::$LINE_BREAK;
 		}
 		
-		if(count($this->cc_array) > 0)
-			$headers .= 'CC: ' . implode(', ', $this->cc_array) . self::$LINE_BREAK;
-		if(count($this->bcc_array) > 0)
-			$headers .= 'BCC: ' . implode(', ', $this->bcc_array) . self::$LINE_BREAK;
+		if(count($this->cc_array) > 0) {
+					$headers .= 'CC: ' . implode(', ', $this->cc_array) . self::$LINE_BREAK;
+		}
+		if(count($this->bcc_array) > 0) {
+					$headers .= 'BCC: ' . implode(', ', $this->bcc_array) . self::$LINE_BREAK;
+		}
 		
-		if(isset($this->attachment_array) && count($this->attachment_array) > 0)
-			$headers .= "Content-Type: multipart/mixed; boundary=\"{$this->get_boundary()}\"";
-		else if(
+		if(isset($this->attachment_array) && count($this->attachment_array) > 0) {
+					$headers .= "Content-Type: multipart/mixed; boundary=\"{$this->get_boundary()}\"";
+		} else if(
 			isset($this->plain_message) && strlen($this->plain_message) > 0 &&
 			isset($this->html_message) && strlen($this->html_message) > 0)
 		{
 			$headers .= "Content-Type: multipart/alternative; boundary=\"{$this->get_alternative_boundary()}\"";
+		} else if(isset($this->html_message) && strlen($this->html_message) > 0) {
+					$headers .= 'Content-type: text/html; charset="iso-8859-1"';
 		}
-		else if(isset($this->html_message) && strlen($this->html_message) > 0)
-			$headers .= 'Content-type: text/html; charset="iso-8859-1"';
 		
 		return $headers;
 	}
@@ -403,8 +414,9 @@ 
 	 */
 	private function is_valid_email_address($string)
 	{
-		if(strlen($string) < 1)
-			return $this->fail_validation("{$string} is an invalid email address!");
+		if(strlen($string) < 1) {
+					return $this->fail_validation("{$string} is an invalid email address!");
+		}
 		
 		return true;
 	}
@@ -422,8 +434,9 @@ 
 	 */
 	private function is_valid_subject($string)
 	{
-		if(strlen($string) < 1)
-			return $this->fail_validation("{$string} is an invalid email subject!");
+		if(strlen($string) < 1) {
+					return $this->fail_validation("{$string} is an invalid email subject!");
+		}
 		
 		return true;
 	}