<?php
/*********************************************************************************
*
* TimeTrex is a Workforce Management program developed by
* TimeTrex Software Inc. Copyright (C) 2003 - 2021 TimeTrex Software Inc.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by
* the Free Software Foundation with the addition of the following permission
* added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
* WORK IN WHICH THE COPYRIGHT IS OWNED BY TIMETREX, TIMETREX DISCLAIMS THE
* WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
*
* You should have received a copy of the GNU Affero General Public License along
* with this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
*
* You can contact TimeTrex headquarters at Unit 22 - 2475 Dobbin Rd. Suite
* #292 West Kelowna, BC V4T 2E9, Canada or at email address info@timetrex.com.
*
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
*
* In accordance with Section 7(b) of the GNU Affero General Public License
* version 3, these Appropriate Legal Notices must retain the display of the
* "Powered by TimeTrex" logo. If the display of the logo is not reasonably
* feasible for technical reasons, the Appropriate Legal Notices must display
* the words "Powered by TimeTrex".
*
********************************************************************************/
/**
* @package Modules\Hierarchy
*/
class HierarchyFactory extends Factory {
protected $table = 'hierarchy'; //Used for caching purposes only.
protected $fasttree_obj = null;
//protected $tmp_data = array(); //Tmp data.
/**
* @return FastTree|null
*/
function getFastTreeObject() {
if ( is_object( $this->fasttree_obj ) ) {
return $this->fasttree_obj;
} else {
global $fast_tree_options;
$this->fasttree_obj = new FastTree( $fast_tree_options );
return $this->fasttree_obj;
}
}
/**
* @return bool|mixed
*/
function getId() {
return $this->getGenericDataValue( 'id' );
}
/**
* @param string $value UUID
* @return bool
*/
function setId( $value ) {
$this->setGenericDataValue( 'id', TTUUID::castUUID( $value ) );
return true;
}
/**
* @return bool|mixed
*/
function getHierarchyControl() {
return $this->getGenericDataValue( 'hierarchy_control_id' );
}
/**
* @param string $value UUID
* @return bool
*/
function setHierarchyControl( $value ) {
$this->setGenericDataValue( 'hierarchy_control_id', TTUUID::castUUID( $value ) );
return true;
}
/**
* Use this for completly editing a row in the tree
* Basically "old_id".
* @return bool|mixed
*/
function getPreviousUser() {
return $this->getGenericDataValue( 'previous_user_id' );
}
/**
* @param string $value UUID
* @return bool
*/
function setPreviousUser( $value ) {
$this->setGenericDataValue( 'previous_user_id', TTUUID::castUUID( $value ) );
return true;
}
/**
* @return bool|mixed
*/
function getParent() {
return $this->getGenericDataValue( 'parent_user_id' );
}
/**
* @param string $value UUID
* @return bool
*/
function setParent( $value ) {
$this->setGenericDataValue( 'parent_user_id', TTUUID::castUUID( $value ) );
return true;
}
/**
* @return bool|mixed
*/
function getUser() {
return $this->getGenericDataValue( 'user_id' );
}
/**
* @param string $value UUID
* @return bool
*/
function setUser( $value ) {
$this->setGenericDataValue( 'user_id', TTUUID::castUUID( $value ) );
return true;
}
/**
* @return bool
*/
function getShared() {
return $this->fromBool( $this->getGenericDataValue( 'shared' ) );
}
/**
* @param $value
* @return bool
*/
function setShared( $value ) {
return $this->setGenericDataValue( 'shared', $this->toBool( $value ) );
}
/**
* @param bool $ignore_warning
* @return bool
*/
function Validate( $ignore_warning = true ) {
if ( $this->getUser() == $this->getParent() ) {
$this->Validator->isTrue( 'parent',
false,
TTi18n::gettext( 'User is the same as parent' )
);
}
//Make sure both user and parent belong to the same company
$ulf = TTnew( 'UserListFactory' ); /** @var UserListFactory $ulf */
$ulf->getById( $this->getUser() );
$user = $ulf->getIterator()->current();
unset( $ulf );
$ulf = TTnew( 'UserListFactory' ); /** @var UserListFactory $ulf */
$ulf->getById( $this->getParent() );
$parent = $ulf->getIterator()->current();
unset( $ulf );
if ( $this->getUser() == TTUUID::getZeroID() && $this->getParent() == TTUUID::getZeroID() ) {
$parent_company_id = TTUUID::getZeroID();
$user_company_id = TTUUID::getZeroID();
} else if ( $this->getUser() == TTUUID::getZeroID() ) {
$parent_company_id = $parent->getCompany();
$user_company_id = $parent->getCompany();
} else if ( $this->getParent() == TTUUID::getZeroID() ) {
$parent_company_id = $user->getCompany();
$user_company_id = $user->getCompany();
} else {
$parent_company_id = $parent->getCompany();
$user_company_id = $user->getCompany();
}
if ( TTUUID::isUUID( $user_company_id ) && $user_company_id != TTUUID::getZeroID() && $user_company_id != TTUUID::getNotExistID() && TTUUID::isUUID( $parent_company_id ) && $parent_company_id != TTUUID::getZeroID() && $parent_company_id != TTUUID::getNotExistID() ) {
Debug::Text( ' User Company: ' . $user_company_id . ' Parent Company: ' . $parent_company_id, __FILE__, __LINE__, __METHOD__, 10 );
if ( $user_company_id != $parent_company_id ) {
$this->Validator->isTrue( 'parent',
false,
TTi18n::gettext( 'User or parent has incorrect company' )
);
}
$this->getFastTreeObject()->setTree( $this->getHierarchyControl() );
$children_arr = $this->getFastTreeObject()->getAllChildren( $this->getUser(), 'RECURSE' );
if ( is_array( $children_arr ) ) {
$children_ids = array_keys( $children_arr );
if ( isset( $children_ids ) && is_array( $children_ids ) && in_array( $this->getParent(), $children_ids ) == true ) {
Debug::Text( ' Objects cant be re-parented to their own children...', __FILE__, __LINE__, __METHOD__, 10 );
$this->Validator->isTrue( 'parent',
false,
TTi18n::gettext( 'Unable to change parent to a child of itself' )
);
}
}
}
return true;
}
/**
* @param bool $reset_data
* @param bool $force_lookup
* @return bool
*/
function Save( $reset_data = true, $force_lookup = false ) {
$this->StartTransaction();
$this->getFastTreeObject()->setTree( $this->getHierarchyControl() );
$retval = true;
if ( $this->getId() === false ) {
Debug::Text( ' Adding Node ', __FILE__, __LINE__, __METHOD__, 10 );
$log_action = 10;
//Add node to tree
if ( $this->getFastTreeObject()->add( $this->getUser(), $this->getParent() ) === false ) {
Debug::Text( ' Failed adding Node ', __FILE__, __LINE__, __METHOD__, 10 );
$this->Validator->isTrue( 'user',
false,
TTi18n::gettext( 'Employee is already assigned to this hierarchy' )
);
$retval = false;
}
} else {
Debug::Text( ' Editing Node ', __FILE__, __LINE__, __METHOD__, 10 );
$log_action = 20;
//Edit node.
if ( $this->getFastTreeObject()->edit( $this->getPreviousUser(), $this->getUser() ) === true ) {
$retval = $this->getFastTreeObject()->move( $this->getUser(), $this->getParent() );
} else {
Debug::Text( ' Failed editing Node ', __FILE__, __LINE__, __METHOD__, 10 );
//$retval = FALSE;
$retval = true;
}
}
TTLog::addEntry( $this->getUser(), $log_action, TTi18n::getText( 'Hierarchy Tree - Control ID' ) . ': ' . $this->getHierarchyControl(), null, $this->getTable() );
$this->CommitTransaction();
//$this->FailTransaction();
$cache_id = $this->getHierarchyControl() . $this->getParent();
$this->removeCache( $cache_id );
return $retval;
}
/**
* @param bool $disable_audit_log
* @return bool
*/
function Delete( $disable_audit_log = false ) {
if ( $this->getUser() !== false ) {
return true;
}
return false;
}
//This table doesn't have any of these columns, so overload the functions.
/**
* @return bool
*/
function getDeleted() {
return false;
}
/**
* @param $bool
* @return bool
*/
function setDeleted( $bool ) {
return false;
}
/**
* @return bool
*/
function getCreatedDate() {
return false;
}
/**
* @param int $epoch EPOCH
* @return bool
*/
function setCreatedDate( $epoch = null ) {
return false;
}
/**
* @return bool
*/
function getCreatedBy() {
return false;
}
/**
* @param string $id UUID
* @return bool
*/
function setCreatedBy( $id = null ) {
return false;
}
/**
* @return bool
*/
function getUpdatedDate() {
return false;
}
/**
* @param int $epoch EPOCH
* @return bool
*/
function setUpdatedDate( $epoch = null ) {
return false;
}
/**
* @return bool
*/
function getUpdatedBy() {
return false;
}
/**
* @param string $id UUID
* @return bool
*/
function setUpdatedBy( $id = null ) {
return false;
}
/**
* @return bool
*/
function getDeletedDate() {
return false;
}
/**
* @param int $epoch EPOCH
* @return bool
*/
function setDeletedDate( $epoch = null ) {
return false;
}
/**
* @return bool
*/
function getDeletedBy() {
return false;
}
/**
* @param string $id UUID
* @return bool
*/
function setDeletedBy( $id = null ) {
return false;
}
}
?>