Your IP : 216.73.217.77
<?php
namespace App\Yantrana\__Laraware\Core;
/**
* Core Repository - 1.8.11 - 16 APR 2024
*
* Base Repository for Laravel applications
*
*
* Dependencies:
*
* Laravel 5.0 + - http://laravel.com
*
*
*-------------------------------------------------------- */
use Cache;
use Closure;
use DB;
use Exception;
abstract class CoreRepository
{
/**
* enable or disable caching viaCache.
*
* @var string
*/
protected $enableCache = true;
// Except this columns & return another columns.
protected $exceptColumns = [];
// Exclude only this columns.
protected $onlyColumns = [];
// With
protected $withItems = [];
/**
* primary model instance
* eg. YourModelModel::class;
*
* @var object
*/
protected $primaryModel;
/**
* Except columns
*
* @param array $columns
* @return object
*
* @since 1.0.0 - 11 JUN 2019 - Added from Base
*-----------------------------------------------------------------------*/
public function exceptColumns(array $exceptColumns)
{
$this->exceptColumns = $exceptColumns;
return $this;
}
/**
* Only this columns
*
* @param array $columns
* @return object
*
* @since 1.0.0 - 11 JUN 2019 - Added from Base
*-----------------------------------------------------------------------*/
public function onlyColumns(array $onlyColumns)
{
$this->onlyColumns = $onlyColumns;
return $this;
}
/**
* With items
*
* @param array|string $columns
* @return object
*
* @since 1.2.5 - 03 JUN 2021
*-----------------------------------------------------------------------*/
public function with($items)
{
if (is_array($items) === false) {
$items = [$items];
}
$this->withItems = $items;
return $this;
}
/**
* DB transaction process.
*/
public function processTransaction(Closure $callback, ?Closure $failback = null)
{
$reactionCode = 14;
$returnProcessReaction = null;
DB::beginTransaction();
// We'll simply execute the given callback within a try / catch block
// and if we catch any exception we can rollback the transaction
// so that none of the changes are persisted to the database.
try {
$reactionCode = $callback($this);
if (is_array($reactionCode) === true) {
$returnProcessReaction = $reactionCode;
$reactionCode = $reactionCode[0];
}
if ($reactionCode == 1) {
DB::commit();
} else {
DB::rollBack();
// custom rollback logic
if ($failback) {
$failback($this);
}
}
}
// If we catch an exception, we will roll back so nothing gets messed
// up in the database. Then we'll re-throw the exception so it can
// be handled how the developer sees fit for their applications.
catch (Exception $e) {
DB::rollBack();
// custom rollback logic
if ($failback) {
$failback($this);
}
$reactionCode = 19;
throw $e;
}
return (__isEmpty($returnProcessReaction) === true)
? $reactionCode : $returnProcessReaction;
}
/**
* To return response from Process Transaction.
*
* @param array $reactionCode - Reaction from Repo
* @param array $data - Array of data if needed
* @param string $message - Message if any
* @return array
*---------------------------------------------------------------- */
public function transactionResponse($reactionCode, $data = null, $message = null)
{
return [
$reactionCode,
$data,
$message,
];
}
/**
* Controllable Cache function for DB Queries.
*
* @param string $cacheId - Cache ID/Key
* @param int/Closure $minutesOrCallback - Number of minutes to remember / Callback containing query to cache
* @param Closure $callback - Callback containing query to cache
* @return array
*---------------------------------------------------------------- */
public function viaCache($cacheId, $minutesOrCallback, ?Closure $callback = null)
{
// check if query cache disabled
if ((config('laraware.enable_db_cache', true) == false) or ($this->enableCache === false)) {
// minutes not sent it must be callable function
if ($minutesOrCallback instanceof Closure) {
return $minutesOrCallback();
}
return $callback();
}
// if minutes sent then remember accordingly
if ($minutesOrCallback and is_numeric($minutesOrCallback) == true) {
return Cache::remember($cacheId, $minutesOrCallback, $callback);
}
// minutes not sent it must be callable function
if ($minutesOrCallback instanceof Closure) {
return Cache::rememberForever($cacheId, $minutesOrCallback);
}
return Cache::rememberForever($cacheId, $callback);
}
/**
* Remove Cache item.
*
* @param string $cacheId - Cache ID/Key
* @return array
*---------------------------------------------------------------- */
public function clearCache($cacheId)
{
return Cache::forget($cacheId);
}
/**
* Fetch the record
*
* @param int|string|array - $idOrUid id or array based where clauses
* @return eloquent collection object
*
* @since 1.0.0 - 11 JUN 2019
*
* @last-modified 1.3.8 - 02 MAR 2022
*---------------------------------------------------------------- */
public function fetchIt($idOrUid)
{
// throw the error if invalid values for search
throw_if((is_null($idOrUid) === true) or ($idOrUid === ''), 'fetchIt: idOrUid should not be null');
// return the result
return $this->configureFetchQuery($idOrUid)->first();
}
/**
* Fetch all the records
*
* @param int|string|array - $idOrUid id or array based where clauses
* @param string - $whereInKey where in key
* @param array - $options where in key
* @return eloquent collection object
*
* @since 1.1.0 - 03 NOV 2020
*
* @last-modified - 22 FEB 2024
*---------------------------------------------------------------- */
public function fetchItAll($idOrUid = null, $columns = [], $whereInKey = null, $options = [])
{
if (empty($columns) === false) {
return $this->configureFetchQuery($idOrUid, $whereInKey, $options)->get($columns);
}
// return the result
return $this->configureFetchQuery($idOrUid, $whereInKey, $options)->get();
}
/**
* Count all the records
*
* @param int|string|array - $idOrUid id or array based where clauses
* @param string - $whereInKey where in key
* @param array - $options where in key
*
* @return int
*
* @since 1.3.6 - 29 JUN 2021
*
* @last-modified - 22 FEB 2024
*---------------------------------------------------------------- */
public function countIt($idOrUid = null, $whereInKey = null, $options = [])
{
// return the count
return $this->configureFetchQuery($idOrUid, $whereInKey, $options)->count();
}
/**
* Fetch all the records
*
* @param int|string|array - $idOrUid
* @param string - $whereInKey
* @param array - $options where in key
*
* @return query object
*
* @since 1.1.0 - 03 NOV 2020
*
* @last-modified - 30 MAR 2024
*---------------------------------------------------------------- */
protected function configureFetchQuery($idOrUid = null, $whereInKey = null, $options = [])
{
$options = array_merge([
'where' => []
], $options);
// create eloquent instance
$primaryModel = new $this->primaryModel();
// start query
$query = $primaryModel::query();
if ($idOrUid) {
// check if its numeric id or uuid
if (is_numeric($idOrUid)) {
// if numeric id it must be primary key
$query->where($primaryModel->getKeyName(), $idOrUid);
} elseif (is_array($idOrUid) and $whereInKey) {
// is array and if it is empty then added dummy item to prevent
// false result that may all the result get backed
if(empty($idOrUid)) {
$idOrUid = [
'___no_where_in_items___'
];
}
$query->whereIn($whereInKey, $idOrUid);
} elseif (is_array($idOrUid)) {
// is array
$query->where($idOrUid);
} else {
// if not then its uuid
$query->where($primaryModel->getUidKeyName(), $idOrUid);
}
}
// useful in case of where in etc
if(!empty($options['where'])) {
$query->where($options['where']);
}
// get all the columns except
if (! empty($this->exceptColumns)) {
$query->selectExcept($this->exceptColumns);
}
// get only defined columns
if (! empty($this->onlyColumns)) {
$query->selectOnly($this->onlyColumns);
}
// get only defined columns
if (! empty($this->withItems)) {
$query->with($this->withItems);
}
$this->withItems = $this->onlyColumns = $this->exceptColumns = [];
return $query;
}
/**
* Store record
*
* @return eloquent collection object | bool (false)
*
* @since 1.0.0 - 11 JUN 2019
*---------------------------------------------------------------- */
public function storeIt(array $inputData, array $keyValues = [])
{
if (empty($keyValues)) {
$keyValues = array_keys($inputData);
}
// create eloquent instance
$primaryModel = new $this->primaryModel();
// assign & save
if ($primaryModel->assignInputsAndSave($inputData, $keyValues)) {
return $primaryModel;
}
return false;
}
/**
* Delete Record
*
* @param object|int|string|array $eloquentModel
* @return bool
*
* @since 1.0.0 - 11 JUN 2019
*
* @last-modified - 22 JUN 2021
*-----------------------------------------------------------------------*/
public function deleteIt($eloquentModel)
{
// check if id or uid sent if so fetch that record eloquent object
if (is_string($eloquentModel) or is_int($eloquentModel) or is_array($eloquentModel)) {
$eloquentModel = $this->fetchIt($eloquentModel);
}
if ($eloquentModel->deleteIt()) {
return true;
}
return false;
}
/**
* delete all the matching records
*
* @param int|string|array - $idOrUid id or array based where clauses
* @param string - $whereInKey where in key
* @param array - $options where in key
*
* @return eloquent collection object
*
* @since 1.5.9 - 03 NOV 2020
*
* @last-modified - 22 FEB 2024
*---------------------------------------------------------------- */
public function deleteItAll($idOrUid, $whereInKey = null, $options = [])
{
// return the result
return $this->configureFetchQuery($idOrUid, $whereInKey, $options)->delete();
}
/**
* update Record
*
* @param object|int|string $eloquentModel
* @param array $inputData
* @return bool
*
* @since 1.0.0 - 11 JUN 2019
*
* @last-modified 1.3.7 - 17 SEP 2021
*-----------------------------------------------------------------------*/
public function updateIt($eloquentModel, $inputData)
{
// check if id or uid sent if so fetch that record eloquent object
if (is_string($eloquentModel) or is_int($eloquentModel) or is_array($eloquentModel)) {
$eloquentModel = $this->fetchIt($eloquentModel);
}
if ($eloquentModel->modelUpdate($inputData)) {
return true;
}
return false;
}
/**
* Update multiple Records with same values
* Note: If you have clear and our non json structure data then it would be better
* to use direct update method by creating functionality in the respective Repository
*
* @param object|int|string $eloquentModels
* @param array $inputData
* @return bool|int - number of results updated
*
* @since 1.8.11 - 16 APR 2024
*-----------------------------------------------------------------------*/
public function updateItAll($eloquentModels, $inputData)
{
if (is_string($eloquentModels) or is_int($eloquentModels) or is_array($eloquentModels)) {
$eloquentModels = $this->fetchItAll($eloquentModels);
}
$updatedModels = 0;
foreach ($eloquentModels as $eloquentModel) {
if ($eloquentModel->modelUpdate($inputData)) {
$updatedModels++;
}
}
unset($eloquentModels);
return $updatedModels;
}
/**
* Store multiple records
*
* @param array $input - it should be array within array
* @param bool/string $returnColumn - if you want ids of the inserted records
* @return bool|mixed|array
*
* @since 1.4.9 - 18 JAN 2024
*
* @updated 1.5.10 - 19 JAN 2024
*---------------------------------------------------------------- */
public function storeItAll(array $inputData, $returnColumn = false)
{
return (new $this->primaryModel())->prepareAndInsert($inputData, $returnColumn);
}
/**
* Bunch inserts or update
*
* @param array $data - Data to update along with index key passed using 2nd parameter
* @param string $index - Index key
* @param array $whereConditions - Where condition with key & value
*
* @since 1.6.10 - 12 FEB 2024
*
*/
public function bunchInsertOrUpdate(array $data, ?string $index = null, $whereConditions = [])
{
if($index) {
return (new $this->primaryModel())->bunchInsertUpdate($data, $index, $whereConditions);
}
return (new $this->primaryModel())->prepareAndInsert($data);
}
}