TimeTrex/classes/modules/core/BreadCrumb.class.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 Core
 */
class BreadCrumb {
	static $home_name = 'Home';
	static $seperator = ' > ';

	/**
	 * @param $name
	 * @param null $url
	 * @return bool
	 * @throws DBError
	 */
	static function setCrumb( $name, $url = null ) {
		global $db, $current_user;

		//
		// If bread crumbs "seem" like they are getting overwritten, make sure the
		// setCrumb function is being called ONLY in the default section of the switch statement. NOT THE TOP.
		//

		if ( $url == '' ) {
			$url = $_SERVER['REQUEST_URI'];
		}

		if ( !is_object( $current_user ) ) {
			return false;
		}

		Debug::text( 'Dropping Bread Crumb: ' . $name . ' URL: ' . $url, __FILE__, __LINE__, __METHOD__, 10 );

		$ph = [
				'user_id' => $current_user->getId(),
				'name'    => $name,
		];

		//Determine if we should update or insert bread crumb.
		$query = 'select name
					FROM bread_crumb
					WHERE user_id = ?
						AND name = ?
					LIMIT 1';
		try {
			$rs = $db->Execute( $query, $ph );
		} catch ( Exception $e ) {
			throw new DBError( $e );
		}

		if ( $rs->RecordCount() == 1 ) {
			$ph = [
					'url'          => $url,
					'created_date' => TTDate::getTime(),
					'user_id'      => $current_user->getId(),
					'name'         => $name,
			];

			$query = 'UPDATE bread_crumb
						SET		url = ?,
								created_date = ?
						WHERE	user_id = ?
							AND name = ?';
		} else {
			$ph = [
					'user_id'      => $current_user->getId(),
					'name'         => $name,
					'url'          => $url,
					'created_date' => TTDate::getTime(),
			];

			$query = 'insert into bread_crumb (user_id, name, url, created_date)
							VALUES(
									?,
									?,
									?,
									?
								)';
		}
		try {
			$db->Execute( $query, $ph );
		} catch ( Exception $e ) {
			throw new DBError( $e );
		}

		return true;
	}

	/**
	 * @return array|bool
	 * @throws DBError
	 */
	static function getCrumbs() {
		global $db, $current_user;

		$ph = [
				'user_id' => $current_user->getId(),
		];

		$query = 'SELECT name, url
					FROM bread_crumb
					WHERE user_id = ?
					ORDER BY created_date DESC
					LIMIT 5';

		//Debug::text('Query: '. $query, __FILE__, __LINE__, __METHOD__, 10);

		try {
			$rs = $db->Execute( $query, $ph );
		} catch ( Exception $e ) {
			throw new DBError( $e );
		}

		$result = $rs->GetRows();
		$retarr = [];
		foreach ( $result as $row ) {
			$retarr[] = [
					'name' => $row['name'],
					'url'  => $row['url'],
			];
			//Debug::text('Picking up Bread Crumb: '. $row['name'] .' URL: '. $row['url'], __FILE__, __LINE__, __METHOD__, 10);
		}

		if ( empty( $retarr ) == false ) {
			return $retarr;
		}

		return false;
	}

	/**
	 * @param string $user_id UUID
	 * @return bool
	 * @throws DBError
	 */
	static function Delete( $user_id = null ) {
		global $db, $current_user;

		if ( empty( $user_id ) || $user_id == TTUUID::getZeroID() ) {
			if ( is_object( $current_user ) ) {
				$user_id = $current_user->getId();
			} else {
				return false;
			}
		}

		$ph = [
				'user_id' => TTUUID::castUUID( $user_id ),
		];

		$query = 'DELETE FROM bread_crumb where user_id = ?';

		try {
			$rs = $db->Execute( $query, $ph );
			unset( $rs ); //code standards
		} catch ( Exception $e ) {
			throw new DBError( $e );
		}

		return true;
	}

	/**
	 * Used to return to the last URL the user visited.
	 * @param int $num
	 * @return mixed
	 */
	static function getReturnCrumb( $num = 1 ) {
		$crumbs = self::getCrumbs();

		return $crumbs[$num]['url'];
	}

	/**
	 * @return string
	 */
	static function Display() {
		$crumbs = self::getCrumbs();

		if ( is_array( $crumbs ) ) {
			$crumbs = array_reverse( $crumbs );
		}

		$links = [];
		//var_dump($crumbs);
		$links[] = '<a href="' . Environment::getBaseURL() . '">' . TTi18n::gettext( self::$home_name ) . '</a>';

		if ( $crumbs != false ) {
			$total_crumbs = count( $crumbs );
			$i = 1;
			foreach ( $crumbs as $crumb ) {
				if ( !( $i == 1 && $crumb['name'] == 'Home' ) ) {
					if ( $i == $total_crumbs ) {
						$links[] = TTi18n::gettext( $crumb['name'] );
					} else {
						if ( $crumb['name'] != 'Home' ) {
							$links[] = '<a href="' . $crumb['url'] . '">' . TTi18n::gettext( $crumb['name'] ) . '</a>';
						}
					}
				}
				$i++;
			}
		}

		return implode( self::$seperator, $links );
	}
}

?>