oms-HumanResourceTimeRecording/Models/SessionMapper.php

<?php
/**
 * Orange Management
 *
 * PHP Version 7.4
 *
 * @package   Modules\HumanResourceTimeRecording\Models
 * @copyright Dennis Eichhorn
 * @license   OMS License 1.0
 * @version   1.0.0
 * @link      https://orange-management.org
 */
declare(strict_types=1);

namespace Modules\HumanResourceTimeRecording\Models;

use Modules\HumanResourceManagement\Models\EmployeeMapper;
use phpOMS\DataStorage\Database\DataMapperAbstract;
use phpOMS\DataStorage\Database\Query\Builder;
use phpOMS\DataStorage\Database\RelationType;
use phpOMS\Stdlib\Base\SmartDateTime;

/**
 * Mapper class.
 *
 * @package Modules\HumanResourceTimeRecording\Models
 * @license OMS License 1.0
 * @link    https://orange-management.org
 * @since   1.0.0
 */
final class SessionMapper extends DataMapperAbstract
{
    /**
     * Columns.
     *
     * @var array<string, array{name:string, type:string, internal:string, autocomplete?:bool, readonly?:bool, writeonly?:bool, annotations?:array}>
     * @since 1.0.0
     */
    protected static array $columns = [
        'hr_timerecording_session_id'       => ['name' => 'hr_timerecording_session_id',       'type' => 'int',      'internal' => 'id'],
        'hr_timerecording_session_type'     => ['name' => 'hr_timerecording_session_type',     'type' => 'int',      'internal' => 'type'],
        'hr_timerecording_session_start'    => ['name' => 'hr_timerecording_session_start',    'type' => 'DateTime', 'internal' => 'start'],
        'hr_timerecording_session_end'      => ['name' => 'hr_timerecording_session_end',      'type' => 'DateTime', 'internal' => 'end'],
        'hr_timerecording_session_busy'     => ['name' => 'hr_timerecording_session_busy',     'type' => 'int',      'internal' => 'busy'],
        'hr_timerecording_session_employee' => ['name' => 'hr_timerecording_session_employee', 'type' => 'int',      'internal' => 'employee'],
    ];

    /**
     * Has many relation.
     *
     * @var array<string, array{mapper:string, table:string, self?:?string, external?:?string, column?:string}>
     * @since 1.0.0
     */
    protected static array $hasMany = [
        'sessionElements' => [
            'mapper' => SessionElementMapper::class,
            'table'  => 'hr_timerecording_session_element',
            'external' => 'hr_timerecording_session_element_session',
            'self'   => null,
        ],
    ];

    /**
     * Belongs to.
     *
     * @var array<string, array{mapper:string, self:string}>
     * @since 1.0.0
     */
    protected static array $belongsTo = [
        'employee' => [
            'mapper' => EmployeeMapper::class,
            'self'   => 'hr_timerecording_session_employee',
        ],
    ];

    /**
     * Primary table.
     *
     * @var string
     * @since 1.0.0
     */
    protected static string $table = 'hr_timerecording_session';

    /**
     * Primary field name.
     *
     * @var string
     * @since 1.0.0
     */
    protected static string $primaryField = 'hr_timerecording_session_id';

    /**
     * Created at column
     *
     * @var string
     * @since 1.0.0
     */
    protected static string $createdAt = 'hr_timerecording_session_start';

    /**
     * Get last sessions from all employees
     *
     * @return Session[]
     *
     * @todo Orange-Management/Modules#189
     *  Currently the last work session of all employees is returned. This should be optionally reduced to only return active employees.
     *  Alternatively it might make sense to limit the last session by an oldest date.
     *
     * @since 1.0.0
     */
    public static function getLastSessionsFromAllEmployees(\DateTime $dt = null) : array
    {
        $join = new Builder(self::$db);
        $join->select(self::$table . '.hr_timerecording_session_employee')
            ->selectAs('MAX(hr_timerecording_session_start)', 'maxDate')
            ->from(self::$table)
            ->groupBy(self::$table . '.hr_timerecording_session_employee');

        $depth = 3;
        $query = self::getQuery();
        $query->innerJoin($join, 'tm')
            ->on(self::$table . '_' . $depth . '.hr_timerecording_session_employee', '=', 'tm.hr_timerecording_session_employee')
            ->andOn(self::$table . '_' . $depth . '.hr_timerecording_session_start', '=', 'tm.maxDate');

        return self::getAllByQuery($query, RelationType::ALL, $depth);
    }

    /**
     * Get the most plausible open session for an employee.
     *
     * This searches for an open session that could be ongoing. This is required to automatically select
     * the current session for breaks, work continuation and ending work sessions without manually selecting
     * the current session.
     *
     * @param int $employee Employee id
     *
     * @return null|Session
     *
     * @since 1.0.0
     */
    public static function getMostPlausibleOpenSessionForEmployee(int $employee) : ?Session
    {
        $dt = new SmartDateTime('now');
        $dt->smartModify(0, 0, -32);

        $depth = 3;
        $query = self::getQuery();
        $query->where(self::$table . '_' . $depth . '.hr_timerecording_session_employee', '=', $employee)
            ->andWhere(self::$table . '_' . $depth . '.hr_timerecording_session_start', '>', $dt)
            ->orderBy(self::$table . '_' . $depth . '.hr_timerecording_session_start', 'DESC')
            ->limit(1);

        /** @var Session[] $sessions */
        $sessions = self::getAllByQuery($query, RelationType::ALL, $depth);

        if (empty($sessions)) {
            return null;
        }

        if (\end($sessions)->getEnd() === null) {
            return \end($sessions);
        }

        return null;
    }

    /**
     * Get sessions for employee
     *
     * @param int       $employee Employee id
     * @param \DateTime $start    Start
     * @param int       $offset   Offset
     * @param int       $limit    Result limit
     *
     * @return Session[]
     *
     * @since 1.0.0
     */
    public static function getSessionListForEmployee(int $employee, \DateTime $start, int $offset = 0, int $limit = 50) : array
    {
        $depth = 3;
        $query = new Builder(self::$db);
        $query = self::getQuery($query)
            ->where(self::$table . '_' . $depth . '.hr_timerecording_session_employee', '=', $employee)
            ->andWhere(self::$table . '_' . $depth . '.' . self::$createdAt, '<=', $start->format('Y-m-d H:i:s'))
            ->orderBy(self::$table . '_' . $depth . '.' . self::$createdAt, 'DESC')
            ->offset($offset)
            ->limit($limit);

        $sth = self::$db->con->prepare($query->toSql());
        $sth->execute();

        $results = $sth->fetchAll(\PDO::FETCH_ASSOC);
        $objs    = self::populateIterable($results === false ? [] : $results);

        foreach ($objs as $obj) {
            self::fillRelations($obj, RelationType::ALL, 6);
        }

        self::clear();

        return $objs;
    }
}