-$mail = new YiiMailer('contact', array('message' => $model->body, 'name' => $model->name, 'description' => 'Contact form'));
+$mail = new YiiMailer('contact', array('message' => 'Message to send', 'name' => 'John Doe', 'description' => 'Contact form'));
+
+or
+
+$mail = new YiiMailer();
+$mail -> setView('contact');
+$mail -> setData(array('message' => 'Message to send', 'name' => 'John Doe', 'description' => 'Contact form'));
Layout is automatically set from config but you may override it with $mail->setLayout('layoutName')
Render HTML mail and set properties:
$mail->render(); -$mail->From = $model->email; -$mail->FromName = $model->name; -$mail->Subject = $model->subject; +$mail->From = 'from@example.com'; +$mail->FromName = 'John Doe'; +$mail->Subject = 'Mail subject'; $mail->AddAddress(Yii::app()->params['adminEmail']);You may use all PHPMailer properties you would usually use. @@ -46,6 +53,6 @@ if ($mail->Send()) { } -## Example +## Examples -View included example with standard yii contact form. \ No newline at end of file +Two examples included: one for standard contact form in yii webb app and the other one for yii console app. \ No newline at end of file diff --git a/YiiMailer.php b/YiiMailer.php index 65137d8..cb43d63 100644 --- a/YiiMailer.php +++ b/YiiMailer.php @@ -23,7 +23,7 @@ * @author Vernes Šiljegović * @copyright Copyright (c) 2013 YiiMailer * @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL - * @version 1.0, 2013-01-02 + * @version 1.1, 2013-02-02 */ @@ -93,12 +93,12 @@ private function setConfig($config) * @param string $view View file * @throws CException */ - private function setView($view) + public function setView($view) { if($view!='') { - if(!is_file(Yii::app()->controller->getViewFile($this->viewPath.'.'.$view))) - throw new CException('View '.$view.' not found'); + if(!is_file($this->getViewFile($this->viewPath.'.'.$view))) + throw new CException('View "'.$view.'" not found'); $this->view=$view; } } @@ -116,7 +116,7 @@ public function getView() * Send data to be used in mail body * @param array $data Data array */ - private function setData($data) + public function setData($data) { $this->data=$data; } @@ -139,8 +139,8 @@ public function setLayout($layout) { if($layout!='') { - if(!is_file(Yii::app()->controller->getViewFile($this->layoutPath.'.'.$layout))) - throw new CException('Layout '.$layout.' not found!'); + if(!is_file($this->getViewFile($this->layoutPath.'.'.$layout))) + throw new CException('Layout "'.$layout.'" not found!'); $this->layout=$layout; } } @@ -162,7 +162,7 @@ public function getLayout() public function setViewPath($path) { if (!is_string($path) && !preg_match("/[a-z0-9\.]/i",$path)) - throw new CException('Path '.$path.' not valid!'); + throw new CException('Path "'.$path.'" not valid!'); $this->viewPath=$path; } @@ -183,7 +183,7 @@ public function getViewPath() public function setLayoutPath($path) { if (!is_string($path) && !preg_match("/[a-z0-9\.]/i",$path)) - throw new CException('Path '.$path.' not valid!'); + throw new CException('Path "'.$path.'" not valid!'); $this->layoutPath=$path; } @@ -204,7 +204,7 @@ public function getLayoutPath() public function setBaseDirPath($path) { if (!is_string($path) && !preg_match("/[a-z0-9\.]/i",$path)) - throw new CException('Path '.$path.' not valid!'); + throw new CException('Path "'.$path.'" not valid!'); $this->baseDirPath=$path; } @@ -217,13 +217,64 @@ public function getBaseDirPath() return $this->baseDirPath; } + /** + * Find the view file for the given view name + * @param string $viewName Name of the view + * @return string The file path or false if the file does not exist + */ + public function getViewFile($viewName) + { + //In web application, use existing method + if(isset(Yii::app()->controller)) + return Yii::app()->controller->getViewFile($viewName); + //resolve the view file + //TODO: support for themes in console applications + if(empty($viewName)) + return false; + + $viewFile=Yii::getPathOfAlias($viewName); + if(is_file($viewFile.'.php')) + return Yii::app()->findLocalizedFile($viewFile.'.php'); + else + return false; + } + + /** + * Render the view file + * @param string $viewName Name of the view + * @param array $viewData Data for extraction + * @return string The rendered result + * @throws CException + */ + public function renderView($viewName,$viewData=null) + { + //resolve the file name + if(($viewFile=$this->getViewFile($viewName))!==false) + { + //use controller instance if available or create dummy controller for console applications + if(isset(Yii::app()->controller)) + $controller=Yii::app()->controller; + else + $controller=new CController(__CLASS__); + + //render and return the result + return $controller->renderInternal($viewFile,$viewData,true); + } + else + { + //file name does not exist + throw new CException('View "'.$viewName.'" does not exist!'); + } + + } + /** * Generates HTML email, with or without layout */ public function render() { //render body - $body=Yii::app()->controller->renderPartial($this->viewPath.'.'.$this->view, $this->data, true); + $body=$this->renderView($this->viewPath.'.'.$this->view, $this->data); if($this->layout) { //has layout @@ -241,9 +292,9 @@ public function render() * @param string $message Email message * @param string $basedir Path for images to embed in message */ - public function MsgHTMLWithLayout($message, $basedir = '') + protected function MsgHTMLWithLayout($message, $basedir = '') { - $this->MsgHTML(Yii::app()->controller->renderPartial($this->layoutPath.'.'.$this->layout, array('content'=>$message,'data'=>$this->data), true), $basedir); + $this->MsgHTML($this->renderView($this->layoutPath.'.'.$this->layout, array('content'=>$message,'data'=>$this->data)), $basedir); } } \ No newline at end of file diff --git a/example/protected/commands/CronCommand.php b/example/protected/commands/CronCommand.php new file mode 100644 index 0000000..f2c2e2c --- /dev/null +++ b/example/protected/commands/CronCommand.php @@ -0,0 +1,34 @@ +setView('cron'); + $mail->setData(array('message' => $cronResult, 'name' => get_class($this), 'description' => 'Cron job', 'mailer' => $mail)); + //render HTML mail, layout is set from config file or with $mail->setLayout('layoutName') + $mail->render(); + //set properties as usually with PHPMailer + $mail->From = 'from@example.com'; + $mail->FromName = 'Console application'; + $mail->Subject = $cronResult; + $mail->AddAddress('to@example.com'); + //send + if ($mail->Send()) { + $mail->ClearAddresses(); + echo 'Mail sent successfuly'; + } else { + echo 'Error while sending email: '.$mail->ErrorInfo; + } + echo PHP_EOL; + } +} \ No newline at end of file diff --git a/example/protected/config/console.php b/example/protected/config/console.php new file mode 100644 index 0000000..d14f896 --- /dev/null +++ b/example/protected/config/console.php @@ -0,0 +1,27 @@ +dirname(__FILE__).DIRECTORY_SEPARATOR.'..', + 'name'=>'My Console Application', + 'import'=>array( + 'ext.YiiMailer.YiiMailer', + ), + // application components + 'components'=>array( + 'db'=>array( + 'connectionString' => 'sqlite:'.dirname(__FILE__).'/../data/testdrive.db', + ), + // uncomment the following to use a MySQL database + /* + 'db'=>array( + 'connectionString' => 'mysql:host=localhost;dbname=testdrive', + 'emulatePrepare' => true, + 'username' => 'root', + 'password' => '', + 'charset' => 'utf8', + ), + */ + ), +); \ No newline at end of file diff --git a/example/protected/views/mail/contact.php b/example/protected/views/mail/contact.php index cc6bc65..9b179ba 100644 --- a/example/protected/views/mail/contact.php +++ b/example/protected/views/mail/contact.php @@ -1,3 +1,5 @@ +
Message from
+You may change the content of this page by modifying the following two files:
Message from
+ +You may change the content of this page by modifying the following two files:
+