TimeTrex/classes/modules/users/UserReportDataListFactory.class.php

605 lines
18 KiB
PHP

<?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\Users
*/
class UserReportDataListFactory extends UserReportDataFactory implements IteratorAggregate {
/**
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return $this
*/
function getAll( $limit = null, $page = null, $where = null, $order = null ) {
$query = '
select *
from ' . $this->getTable() . '
WHERE deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, null, $limit, $page );
return $this;
}
/**
* @param string $id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getById( $id, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
$ph = [
'id' => TTUUID::castUUID( $id ),
];
$query = '
select *
from ' . $this->getTable() . '
where id = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getByUserId( $id, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
$ph = [
'user_id' => TTUUID::castUUID( $id ),
];
$query = '
select *
from ' . $this->getTable() . '
where user_id = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_id UUID
* @param string $id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getByUserIdAndId( $user_id, $id, $where = null, $order = null ) {
if ( $user_id == '' ) {
return false;
}
if ( $id == '' ) {
return false;
}
$ph = [
'user_id' => TTUUID::castUUID( $user_id ),
'id' => TTUUID::castUUID( $id ),
];
$query = '
select *
from ' . $this->getTable() . '
where user_id = ?
AND id = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_id UUID
* @param $script
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getByUserIdAndScript( $user_id, $script, $where = null, $order = null ) {
if ( $user_id == '' ) {
return false;
}
if ( $script == '' ) {
return false;
} else {
$script = self::handleScriptName( $script );
}
if ( $order == null ) {
$order = [ 'is_default' => 'desc', 'name' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
$ph = [
'user_id' => TTUUID::castUUID( $user_id ),
'script' => $script,
];
$query = '
select *
from ' . $this->getTable() . '
where user_id = ?
AND script = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_id UUID
* @param $script
* @param bool $default
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getByUserIdAndScriptAndDefault( $user_id, $script, $default = true, $where = null, $order = null ) {
if ( $user_id == '' ) {
return false;
}
if ( $script == '' ) {
return false;
} else {
$script = self::handleScriptName( $script );
}
if ( $order == null ) {
$order = [ 'updated_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ph = [
'user_id' => TTUUID::castUUID( $user_id ),
'script' => $script,
'default' => $this->toBool( $default ),
];
$query = '
select *
from ' . $this->getTable() . '
where user_id = ?
AND script = ?
AND is_default = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $user_id UUID
* @param $script
* @param bool $include_blank
* @return array|bool
*/
function getByUserIdAndScriptArray( $user_id, $script, $include_blank = true ) {
$ugdlf = new UserGenericDataListFactory();
$ugdlf->getByUserIdAndScript( $user_id, $script );
$list = [];
if ( $include_blank == true ) {
$list[TTUUID::getZeroID()] = '--';
}
foreach ( $ugdlf as $ugd_obj ) {
if ( $ugd_obj->getDefault() == true ) {
$default = ' (Default)';
} else {
$default = null;
}
$list[$ugd_obj->getID()] = $ugd_obj->getName() . $default;
}
if ( empty( $list ) == false ) {
return $list;
}
return false;
}
/*
Company List Functions
*/
/**
* @param string $id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getByCompanyId( $id, $where = null, $order = null ) {
if ( $id == '' ) {
return false;
}
$ph = [
'id' => TTUUID::castUUID( $id ),
];
$query = '
select *
from ' . $this->getTable() . '
where company_id = ?
AND user_id is NULL
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $company_id UUID
* @param string $id UUID
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getByCompanyIdAndId( $company_id, $id, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $id == '' ) {
return false;
}
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'id' => TTUUID::castUUID( $id ),
];
$query = '
select *
from ' . $this->getTable() . '
where company_id = ?
AND user_id is NULL
AND id = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $company_id UUID
* @param $script
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getByCompanyIdAndScript( $company_id, $script, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $script == '' ) {
return false;
} else {
$script = self::handleScriptName( $script );
}
if ( $order == null ) {
$order = [ 'updated_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'script' => $script,
];
$query = '
select *
from ' . $this->getTable() . '
where company_id = ?
AND user_id is NULL
AND script = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $company_id UUID
* @param $script
* @param bool $default
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getByCompanyIdAndScriptAndDefault( $company_id, $script, $default = true, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( $script == '' ) {
return false;
} else {
$script = self::handleScriptName( $script );
}
if ( $order == null ) {
$order = [ 'updated_date' => 'desc' ];
$strict = false;
} else {
$strict = true;
}
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
'script' => $script,
'default' => $this->toBool( $default ),
];
$query = '
select *
from ' . $this->getTable() . '
where company_id = ?
AND user_id is NULL
AND script = ?
AND is_default = ?
AND deleted = 0';
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict );
$this->rs = $this->ExecuteSQL( $query, $ph );
return $this;
}
/**
* @param string $company_id UUID
* @param $filter_data
* @param int $limit Limit the number of records returned
* @param int $page Page number of records to return for pagination
* @param array $where Additional SQL WHERE clause in format of array( $column => $filter, ... ). ie: array( 'id' => 1, ... )
* @param array $order Sort order passed to SQL in format of array( $column => 'asc', 'name' => 'desc', ... ). ie: array( 'id' => 'asc', 'name' => 'desc', ... )
* @return bool|UserReportDataListFactory
*/
function getAPISearchByCompanyIdAndArrayCriteria( $company_id, $filter_data, $limit = null, $page = null, $where = null, $order = null ) {
if ( $company_id == '' ) {
return false;
}
if ( !is_array( $order ) ) {
//Use Filter Data ordering if its set.
if ( isset( $filter_data['sort_column'] ) && $filter_data['sort_order'] ) {
$order = [ Misc::trimSortPrefix( $filter_data['sort_column'] ) => $filter_data['sort_order'] ];
}
}
$additional_order_fields = [ 'is_scheduled' ];
$sort_column_aliases = [
'script_name' => 'script',
];
$order = $this->getColumnsFromAliases( $order, $sort_column_aliases );
if ( $order == null ) {
$order = [ 'a.name' => 'asc' ];
$strict = false;
} else {
$strict = true;
}
//Debug::Arr($order, 'Order Data:', __FILE__, __LINE__, __METHOD__, 10);
//Debug::Arr($filter_data, 'Filter Data:', __FILE__, __LINE__, __METHOD__, 10);
$uf = new UserFactory();
if ( getTTProductEdition() >= TT_PRODUCT_PROFESSIONAL ) {
$rsf = new ReportScheduleFactory();
}
$ph = [
'company_id' => TTUUID::castUUID( $company_id ),
];
$query = '
select a.* ';
if ( getTTProductEdition() >= TT_PRODUCT_PROFESSIONAL ) {
$query .= ', _ADODB_COUNT
(
CASE WHEN EXISTS (select 1 from ' . $rsf->getTable() . ' as rsf where rsf.user_report_data_id = a.id AND rsf.status_id = 10 AND rsf.deleted = 0 ) THEN 1 ELSE 0 END
) as is_scheduled
_ADODB_COUNT ';
} else {
$query .= ', 0 as is_scheduled ';
}
$query .= ' from ' . $this->getTable() . ' as a
LEFT JOIN ' . $uf->getTable() . ' as y ON ( a.created_by = y.id AND y.deleted = 0 )
LEFT JOIN ' . $uf->getTable() . ' as z ON ( a.updated_by = z.id AND z.deleted = 0 )
where ( a.company_id = ?
';
$query .= ( isset( $filter_data['id'] ) ) ? $this->getWhereClauseSQL( 'a.id', $filter_data['id'], 'uuid_list', $ph ) : null;
$query .= ( isset( $filter_data['user_id'] ) ) ? $this->getWhereClauseSQL( 'a.user_id', $filter_data['user_id'], 'uuid_list', $ph ) : null;
$query .= ( isset( $filter_data['script'] ) ) ? $this->getWhereClauseSQL( 'a.script', $filter_data['script'], 'text', $ph ) : null;
$query .= ( isset( $filter_data['name'] ) ) ? $this->getWhereClauseSQL( 'a.name', $filter_data['name'], 'text', $ph ) : null;
$query .= ( isset( $filter_data['is_default'] ) ) ? $this->getWhereClauseSQL( 'a.is_default', $filter_data['is_default'], 'boolean', $ph ) : null;
//$query .= ( isset($filter_data['is_scheduled']) ) ? $this->getWhereClauseSQL( 'is_scheduled', $filter_data['is_scheduled'], 'boolean', $ph ) : NULL; //Unable to filter by a dynamically generated column.
$query .= ( isset( $filter_data['created_by'] ) ) ? $this->getWhereClauseSQL( [ 'a.created_by', 'y.first_name', 'y.last_name' ], $filter_data['created_by'], 'user_id_or_name', $ph ) : null;
$query .= ( isset( $filter_data['updated_by'] ) ) ? $this->getWhereClauseSQL( [ 'a.updated_by', 'z.first_name', 'z.last_name' ], $filter_data['updated_by'], 'user_id_or_name', $ph ) : null;
$query .= '
AND a.deleted = 0 )
';
//Special case. This is an OR based on the report ids of possibly another user.
if ( isset( $filter_data['include_user_report_id'] ) && TTUUID::isUUID( $filter_data['include_user_report_id'] ) && $filter_data['include_user_report_id'] != TTUUID::getZeroID() ) {
$query .= ' OR ( ( ' . $this->getWhereClauseSQL( 'a.id', $filter_data['include_user_report_id'], 'uuid', $ph, null, false );
$query .= $this->getWhereClauseSQL( 'a.company_id', $company_id, 'uuid_list', $ph ) .' ) ';
$query .= ' AND a.deleted = 0 )';
}
$query .= $this->getWhereSQL( $where );
$query .= $this->getSortSQL( $order, $strict, $additional_order_fields );
$this->rs = $this->ExecuteSQL( $query, $ph, $limit, $page );
//Debug::Query( $query, $ph, __FILE__, __LINE__, __METHOD__, 10);
return $this;
}
/**
* @param $lf
* @param bool $include_blank
* @return array|bool
*/
function getArrayByListFactory( $lf, $include_blank = true ) {
if ( !is_object( $lf ) ) {
return false;
}
$list = [];
if ( $include_blank == true ) {
$list[TTUUID::getZeroID()] = '--';
}
foreach ( $lf as $obj ) {
$list[$obj->getID()] = $obj->getName();
}
if ( empty( $list ) == false ) {
return $list;
}
return false;
}
/**
* @param string $company_id UUID
* @param $script
* @param bool $include_blank
* @return array|bool
*/
function getByCompanyIdAndScriptArray( $company_id, $script, $include_blank = true ) {
$ugdlf = new UserGenericDataListFactory();
$ugdlf->getByUserIdAndScript( $company_id, $script );
$list = [];
if ( $include_blank == true ) {
$list[TTUUID::getZeroID()] = '--';
}
foreach ( $ugdlf as $ugd_obj ) {
if ( $ugd_obj->getDefault() == true ) {
$default = ' (Default)';
} else {
$default = null;
}
$list[$ugd_obj->getID()] = $ugd_obj->getName() . $default;
}
if ( empty( $list ) == false ) {
return $list;
}
return false;
}
}
?>