1: <?php
  2: /*****************************************************************************************
  3:  * X2Engine Open Source Edition is a customer relationship management program developed by
  4:  * X2Engine, Inc. Copyright (C) 2011-2016 X2Engine Inc.
  5:  * 
  6:  * This program is free software; you can redistribute it and/or modify it under
  7:  * the terms of the GNU Affero General Public License version 3 as published by the
  8:  * Free Software Foundation with the addition of the following permission added
  9:  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 10:  * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
 11:  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 12:  * 
 13:  * This program is distributed in the hope that it will be useful, but WITHOUT
 14:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 15:  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 16:  * details.
 17:  * 
 18:  * You should have received a copy of the GNU Affero General Public License along with
 19:  * this program; if not, see http://www.gnu.org/licenses or write to the Free
 20:  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 21:  * 02110-1301 USA.
 22:  * 
 23:  * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
 24:  * California 95067, USA. or at email address [email protected].
 25:  * 
 26:  * The interactive user interfaces in modified source and object code versions
 27:  * of this program must display Appropriate Legal Notices, as required under
 28:  * Section 5 of the GNU Affero General Public License version 3.
 29:  * 
 30:  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 31:  * these Appropriate Legal Notices must retain the display of the "Powered by
 32:  * X2Engine" logo. If the display of the logo is not reasonably feasible for
 33:  * technical reasons, the Appropriate Legal Notices must display the words
 34:  * "Powered by X2Engine".
 35:  *****************************************************************************************/
 36: 
 37: /**
 38:  * X2TimestampBehavior class file.
 39:  * 
 40:  * @package application.components 
 41:  * X2TimestampBehavior automatically fills in lastUpdated and createDate (if these fields exist)
 42:  */
 43: class X2TimestampBehavior extends CActiveRecordBehavior {
 44: 
 45:     protected $_hasCreateDate;
 46:     protected $_hasLastUpdated;
 47:     protected $_hasLastActivity;
 48: 
 49:     protected $_oldCreateDate = null;
 50:     protected $_oldLastUpdated = null;
 51:     protected $_oldLastActivity = null;
 52: 
 53:     public function attach($owner) {
 54:         parent::attach($owner);
 55:         
 56:         $this->_hasCreateDate = $this->getOwner()->hasAttribute('createDate');
 57:         $this->_hasLastUpdated = $this->getOwner()->hasAttribute('lastUpdated');
 58:         $this->_hasLastActivity = $this->getOwner()->hasAttribute('lastActivity');
 59:     }
 60: 
 61:     public function afterFind($event) {
 62:         if(!$this->getOwner()->getIsNewRecord()) {  // if we're updating a model, get the old attributes
 63:             if($this->_hasCreateDate)
 64:                 $this->_oldCreateDate = $this->getOwner()->createDate;
 65:             
 66:             if($this->_hasLastUpdated)
 67:                 $this->_oldLastUpdated = $this->getOwner()->lastUpdated;
 68:             
 69:             if($this->_hasLastActivity)
 70:                 $this->_oldLastActivity = $this->getOwner()->lastActivity;
 71:         }
 72:     }
 73: 
 74:     /**
 75:     * Responds to {@link CModel::onBeforeValidate} event.
 76:     * Sets the values of the creation or modified attributes as configured.
 77:     * Does not set the value if a value has already been set manually (i.e., the current value != the original value, or the new value is null)
 78:     *
 79:     * @param CModelEvent $event event parameter
 80:     */
 81:     public function beforeValidate($event) {
 82:         if($this->_hasCreateDate && ($this->getOwner()->getIsNewRecord() && $this->getOwner()->createDate === null))    // only fill createDate if we're creating it
 83:             $this->getOwner()->createDate = time();
 84:         
 85:         if($this->_hasLastUpdated && ($this->getOwner()->lastUpdated === null || $this->getOwner()->lastUpdated === $this->_oldLastUpdated))
 86:             $this->getOwner()->lastUpdated = time();
 87:         
 88:         if($this->_hasLastActivity && ($this->getOwner()->lastActivity === null || $this->getOwner()->lastActivity === $this->_oldLastActivity))
 89:             $this->getOwner()->lastActivity = time();
 90:     }
 91: 
 92:     /**
 93:     * Manually sets the lastActivity attribute
 94:     *
 95:     * @param CModelEvent $event event parameter
 96:     */
 97:     public function updateLastActivity() {
 98:         if($this->_hasLastActivity) {
 99:             // $this->getOwner()->disableBehavior('changelog');
100:             $this->getOwner()->lastActivity = time();
101:             $this->getOwner()->update(array('lastActivity'));   // don't use save() so it doesn't trigger beforeValidate()
102:             // $this->getOwner()->enableBehavior('changelog');
103:         }
104:     }
105: }