1: <?php
 2: 
 3: /*****************************************************************************************
 4:  * X2Engine Open Source Edition is a customer relationship management program developed by
 5:  * X2Engine, Inc. Copyright (C) 2011-2016 X2Engine Inc.
 6:  * 
 7:  * This program is free software; you can redistribute it and/or modify it under
 8:  * the terms of the GNU Affero General Public License version 3 as published by the
 9:  * Free Software Foundation with the addition of the following permission added
10:  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11:  * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
12:  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
13:  * 
14:  * This program is distributed in the hope that it will be useful, but WITHOUT
15:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16:  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
17:  * details.
18:  * 
19:  * You should have received a copy of the GNU Affero General Public License along with
20:  * this program; if not, see http://www.gnu.org/licenses or write to the Free
21:  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22:  * 02110-1301 USA.
23:  * 
24:  * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
25:  * California 95067, USA. or at email address contact@x2engine.com.
26:  * 
27:  * The interactive user interfaces in modified source and object code versions
28:  * of this program must display Appropriate Legal Notices, as required under
29:  * Section 5 of the GNU Affero General Public License version 3.
30:  * 
31:  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32:  * these Appropriate Legal Notices must retain the display of the "Powered by
33:  * X2Engine" logo. If the display of the logo is not reasonably feasible for
34:  * technical reasons, the Appropriate Legal Notices must display the words
35:  * "Powered by X2Engine".
36:  *****************************************************************************************/
37: 
38: Yii::import('application.components.util.*');
39: 
40: /**
41:  * 
42:  * @package
43:  * @author Demitri Morgan <demitri@x2engine.com>
44:  */
45: abstract class X2ConsoleCommand extends CConsoleCommand {
46: 
47:     private $_formatter;
48: 
49:     /**
50:      * Returns a new formatter object for formatting a given message.
51:      */
52:     public function formatter($msg) {
53:         return new ConsoleFormatterUtil($msg);
54:     }
55: 
56:     /**
57:      * Echoes something in bold and a color
58:      *
59:      * @param string $msg Message to echo
60:      * @param string $color The color to echo in.
61:      * @param bool $newline Whether or not to insert a newline at the end
62:      */
63:     public function headerMsg($msg,$color='green',$newline=true){
64:         echo $this->formatter($msg)->bold()->color($color)->format().($newline?"\n":"");
65:     }
66: }
67: 
68: 
69: ?>
70: