Skip to content

Commit

Permalink
Update doc blocks for Email to return $this.
Browse files Browse the repository at this point in the history 
Refs #3787
  • Loading branch information
@markstory
markstory committed Jun 24, 2014
1 parent 67a767a commit a41d646
Showing 1 changed file with 32 additions and 32 deletions.
64 changes: 32 additions & 32 deletions src/Network/Email/Email.php
View file
Expand Up @@ -371,7 +371,7 @@ public function __construct($config = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return array|\Cake\Network\Email\Email
* @return array|$this
* @throws \Cake\Network\Error\SocketException
*/
public function from($email = null, $name = null) {
Expand All @@ -387,7 +387,7 @@ public function from($email = null, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return array|\Cake\Network\Email\Email
* @return array|$this
* @throws \Cake\Network\Error\SocketException
*/
public function sender($email = null, $name = null) {
Expand All @@ -403,7 +403,7 @@ public function sender($email = null, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return array|\Cake\Network\Email\Email
* @return array|$this
* @throws \Cake\Network\Error\SocketException
*/
public function replyTo($email = null, $name = null) {
Expand All @@ -419,7 +419,7 @@ public function replyTo($email = null, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return array|\Cake\Network\Email\Email
* @return array|$this
* @throws \Cake\Network\Error\SocketException
*/
public function readReceipt($email = null, $name = null) {
Expand All @@ -435,7 +435,7 @@ public function readReceipt($email = null, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return array|\Cake\Network\Email\Email
* @return array|$this
* @throws \Cake\Network\Error\SocketException
*/
public function returnPath($email = null, $name = null) {
Expand All @@ -451,7 +451,7 @@ public function returnPath($email = null, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return array|\Cake\Network\Email\Email
* @return array|$this
*/
public function to($email = null, $name = null) {
if ($email === null) {
Expand All @@ -466,7 +466,7 @@ public function to($email = null, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return \Cake\Network\Email\Email $this
* @return $this
*/
public function addTo($email, $name = null) {
return $this->_addEmail('_to', $email, $name);
Expand All @@ -478,7 +478,7 @@ public function addTo($email, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return array|\Cake\Network\Email\Email
* @return array|$this
*/
public function cc($email = null, $name = null) {
if ($email === null) {
Expand All @@ -493,7 +493,7 @@ public function cc($email = null, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return \Cake\Network\Email\Email $this
* @return $this
*/
public function addCc($email, $name = null) {
return $this->_addEmail('_cc', $email, $name);
Expand All @@ -505,7 +505,7 @@ public function addCc($email, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return array|\Cake\Network\Email\Email
* @return array|$this
*/
public function bcc($email = null, $name = null) {
if ($email === null) {
Expand All @@ -520,7 +520,7 @@ public function bcc($email = null, $name = null) {
* @param string|array $email Null to get, String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return \Cake\Network\Email\Email $this
* @return $this
*/
public function addBcc($email, $name = null) {
return $this->_addEmail('_bcc', $email, $name);
Expand Down Expand Up @@ -560,7 +560,7 @@ public function headerCharset($charset = null) {
* EmailPattern setter/getter
*
* @param string $regex for email address validation
* @return string|\Cake\Network\Email\Email
* @return string|$this
*/
public function emailPattern($regex = null) {
if ($regex === null) {
Expand All @@ -577,7 +577,7 @@ public function emailPattern($regex = null) {
* @param string|array $email String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return \Cake\Network\Email\Email $this
* @return $this
* @throws \Cake\Network\Error\SocketException
*/
protected function _setEmail($varName, $email, $name) {
Expand Down Expand Up @@ -626,7 +626,7 @@ protected function _validateEmail($email) {
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @param string $throwMessage Exception message
* @return \Cake\Network\Email\Email $this
* @return $this
* @throws \Cake\Network\Error\SocketException
*/
protected function _setEmailSingle($varName, $email, $name, $throwMessage) {
Expand All @@ -646,7 +646,7 @@ protected function _setEmailSingle($varName, $email, $name, $throwMessage) {
* @param string|array $email String with email,
* Array with email as key, name as value or email as value (without name)
* @param string $name Name
* @return \Cake\Network\Email\Email $this
* @return $this
* @throws \Cake\Network\Error\SocketException
*/
protected function _addEmail($varName, $email, $name) {
Expand Down Expand Up @@ -674,7 +674,7 @@ protected function _addEmail($varName, $email, $name) {
* Get/Set Subject.
*
* @param string $subject Subject string.
* @return string|\Cake\Network\Email\Email
* @return string|$this
*/
public function subject($subject = null) {
if ($subject === null) {
Expand All @@ -688,7 +688,7 @@ public function subject($subject = null) {
* Sets headers for the message
*
* @param array $headers Associative array containing headers to be set.
* @return \Cake\Network\Email\Email $this
* @return $this
* @throws \Cake\Network\Error\SocketException
*/
public function setHeaders($headers) {
Expand All @@ -703,7 +703,7 @@ public function setHeaders($headers) {
* Add header for the message
*
* @param array $headers Headers to set.
* @return object $this
* @return $this
* @throws \Cake\Network\Error\SocketException
*/
public function addHeaders($headers) {
Expand Down Expand Up @@ -836,7 +836,7 @@ protected function _formatAddress($address) {
*
* @param bool|string $template Template name or null to not use
* @param bool|string $layout Layout name or null to not use
* @return array|\Cake\Network\Email\Email
* @return array|$this
*/
public function template($template = false, $layout = false) {
if ($template === false) {
Expand All @@ -856,7 +856,7 @@ public function template($template = false, $layout = false) {
* View class for render
*
* @param string $viewClass View class name.
* @return string|\Cake\Network\Email\Email
* @return string|$this
*/
public function viewRender($viewClass = null) {
if ($viewClass === null) {
Expand All @@ -870,7 +870,7 @@ public function viewRender($viewClass = null) {
* Variables to be set on render
*
* @param array $viewVars Variables to set for view.
* @return array|\Cake\Network\Email\Email
* @return array|$this
*/
public function viewVars($viewVars = null) {
if ($viewVars === null) {
Expand All @@ -884,7 +884,7 @@ public function viewVars($viewVars = null) {
* Theme to use when rendering
*
* @param string $theme Theme name.
* @return string|\Cake\Network\Email\Email
* @return string|$this
*/
public function theme($theme = null) {
if ($theme === null) {
Expand All @@ -898,7 +898,7 @@ public function theme($theme = null) {
* Helpers to be used in render
*
* @param array $helpers Helpers list.
* @return array|\Cake\Network\Email\Email
* @return array|$this
*/
public function helpers($helpers = null) {
if ($helpers === null) {
Expand All @@ -912,7 +912,7 @@ public function helpers($helpers = null) {
* Email format
*
* @param string $format Formatting string.
* @return string|\Cake\Network\Email\Email
* @return string|$this
* @throws \Cake\Network\Error\SocketException
*/
public function emailFormat($format = null) {
Expand All @@ -934,7 +934,7 @@ public function emailFormat($format = null) {
*
* @param string|AbstractTransport $name Either the name of a configured
* transport, or a transport instance.
* @return AbstractTransport|\Cake\Network\Email\Email
* @return \Cake\Network\Email\AbstractTransport|$this
* @throws \Cake\Network\Error\SocketException When the chosen transport lacks a send method.
*/
public function transport($name = null) {
Expand All @@ -959,7 +959,7 @@ public function transport($name = null) {
* Build a transport instance from configuration data.
*
* @param string $name The transport configuration name to build.
* @return AbstractTransport
* @return \Cake\Network\Email\AbstractTransport
* @throws \Cake\Error\Exception When transport configuration is missing or invalid.
*/
protected function _constructTransport($name) {
Expand Down Expand Up @@ -988,7 +988,7 @@ protected function _constructTransport($name) {
* Message-ID
*
* @param bool|string $message True to generate a new Message-ID, False to ignore (not send in email), String to set as Message-ID
* @return bool|string|\Cake\Network\Email\Email
* @return bool|string|$this
* @throws \Cake\Network\Error\SocketException
*/
public function messageId($message = null) {
Expand All @@ -1010,7 +1010,7 @@ public function messageId($message = null) {
* Domain as top level (the part after @)
*
* @param string $domain Manually set the domain for CLI mailing
* @return string|\Cake\Network\Email\Email
* @return string|$this
*/
public function domain($domain = null) {
if ($domain === null) {
Expand Down Expand Up @@ -1064,7 +1064,7 @@ public function domain($domain = null) {
* attachment compatibility with outlook email clients.
*
* @param string|array $attachments String with the filename or array with filenames
* @return array|\Cake\Network\Email\Email Either the array of attachments when getting or $this when setting.
* @return array|$this Either the array of attachments when getting or $this when setting.
* @throws \Cake\Network\Error\SocketException
*/
public function attachments($attachments = null) {
Expand Down Expand Up @@ -1107,7 +1107,7 @@ public function attachments($attachments = null) {
* Add attachments
*
* @param string|array $attachments String with the filename or array with filenames
* @return \Cake\Network\Email\Email $this
* @return $this
* @throws \Cake\Network\Error\SocketException
* @see \Cake\Network\Email\Email::attachments()
*/
Expand Down Expand Up @@ -1189,7 +1189,7 @@ public static function dropTransport($key) {
*
* @param null|string|array $config String with configuration name, or
* an array with config or null to return current config.
* @return string|array|\Cake\Network\Email\Email
* @return string|array|$this
*/
public function profile($config = null) {
if ($config === null) {
Expand Down Expand Up @@ -1331,7 +1331,7 @@ protected function _applyConfig($config) {
/**
* Reset all the internal variables to be able to send out a new email.
*
* @return \Cake\Network\Email\Email $this
* @return $this
*/
public function reset() {
$this->_to = array();
Expand Down

0 comments on commit a41d646

Please sign in to comment.