byjg / anydataset

src/Database/DBBaseFunctions.php

<?php

namespace ByJG\AnyDataset\Database;

use ByJG\AnyDataset\Repository\DBDataset;
use DateTime;

abstract class DBBaseFunctions implements DBFunctionsInterface
{

    const DMY = "d-m-Y";
    const MDY = "m-d-Y";
    const YMD = "Y-m-d";
    const DMYH = "d-m-Y H:i:s";
    const MDYH = "m-d-Y H:i:s";
    const YMDH = "Y-m-d H:i:s";

    /**
     * Given two or more string the system will return the string containing de proper SQL commands to concatenate these string;
     * use:
     *     for ($i = 0, $numArgs = func_num_args(); $i < $numArgs ; $i++)
     * to get all parameters received.
     * @param string $s1
     * @param string $s2
     * @return string
     */
    function concat($s1, $s2 = null)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return "";
    }

    /**
     * Given a SQL returns it with the proper LIMIT or equivalent method included
     * @param string $sql
     * @param int $start
     * @param int $qty
     * @return string
     */
    function limit($sql, $start, $qty)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $sql;
    }

    /**
     * Given a SQL returns it with the proper TOP or equivalent method included
     * @param string $sql
     * @param int $qty
     * @return string
     */
    function top($sql, $qty)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $sql;
    }

    /**
     * Return if the database provider have a top or similar function
     * @return bool
     */
    function hasTop()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return false;
    }

    /**
     * Return if the database provider have a limit function
     * @return bool
     */
    function hasLimit()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return false;
    }

    /**
     * Format date column in sql string given an input format that understands Y M D
     * @param string $fmt
     * @param bool|string $col
     * @return string
     * @example $db->getDbFunctions()->SQLDate("d/m/Y H:i", "dtcriacao")
     */
    function sqlDate($fmt, $col = false)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return "";
    }

    /**
     * Format a string date to a string database readable format.
     *
     * @param string $date
     * @param string $dateFormat
     * @return string
     */
    function toDate($date, $dateFormat)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $dateTime = DateTime::createFromFormat($dateFormat, $date);
        return $dateTime->format(self::YMDH);
    }

    /**
     * Format a string database readable format to a string date in a free format.
     *
     * @param string $date
     * @param string $dateFormat
     * @return string
     */
    function fromDate($date, $dateFormat)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $dateTime = DateTime::createFromFormat(self::YMDH, $date);
        return $dateTime->format($dateFormat);
    }

    /**
     *
     * @param DBDataset $dbdataset
     * @param string $sql
     * @param array $param
     * @param string $sequence
     * @return int
     */
    function executeAndGetInsertedId($dbdataset, $sql, $param, $sequence = null)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $dbdataset->execSQL($sql, $param);
        return -1;
    }
}