Documentation

CustomerRepository extends Repository

Table of Contents

RESPONSE_STATUS_ERROR  = 'error'
RESPONSE_STATUS_FAIL  = 'fail'
RESPONSE_STATUS_SUCCESS  = 'success'
$childRelationName  : mixed
$model  : mixed
$parentRepo  : mixed
$repo  : mixed
__construct()  : object
all()  : array<string|int, mixed>
Show all store´s customers
allChild()  : string
cleanNullValues()  : null
Change null values and put string("")
delete()  : string
Delete customer if its a private customer or delete his store´s relashionship if is public
deleteChild()  : bool
ensureHttp400Code()  : string
Return a extension from mimetype
firstOrCreate()  : object
firstOrNew()  : object
forceDelete()  : bool
getCustomLabelFormat()  : array<string|int, mixed>
Return an array with custom label format
getErrorResponse()  : array<string|int, mixed>
Return all an array of errors like validation in one format
getFailResponse()  : array<string|int, mixed>
Return all an array of errors like validation in one format
getModel()  : Model
getObject()  : array<string|int, mixed>
getSuccessResponse()  : array<string|int, mixed>
Return all an array of errors like validation in one format
getUserStore()  : mixed
mime2ext()  : string
Return a extension from mimetype
orderQuery()  : null
Destroy record from the database
paginate()  : array<string|int, mixed>
Show all store´s customers paginated
paginateChild()  : array<string|int, mixed>
setModel()  : mixed
show()  : array<string|int, mixed>
Show one store´s customer given by id
showChild()  : object
store()  : string
Customer record from the database
storeChild()  : object
update()  : string
updateChild()  : object
getConcatString()  : string
Concatenate string to make it compatible with SQLite
lookForCustomers()  : Customer|null
Used when creating customers to look for existing customer from other stores or public users
storePivotAttributte()  : mixed
Stores attribute in pivot table customers_stores

Constants

RESPONSE_STATUS_ERROR

public mixed RESPONSE_STATUS_ERROR = 'error'

RESPONSE_STATUS_FAIL

public mixed RESPONSE_STATUS_FAIL = 'fail'

RESPONSE_STATUS_SUCCESS

public mixed RESPONSE_STATUS_SUCCESS = 'success'

Properties

$childRelationName

protected mixed $childRelationName

Methods

all()

Show all store´s customers

public all(Request $request) : array<string|int, mixed>
Parameters
$request : Request
Return values
array<string|int, mixed> —

allChild()

public allChild(Request $request, int $parent_id) : string
Parameters
$request : Request
$parent_id : int
  • Id of the parent objects that we want to get.
Tags
desc

Return a database records

Return values
string —

cleanNullValues()

Change null values and put string("")

public cleanNullValues(array<string|int, mixed> &$data[, array<string|int, mixed> $exceptions = [] ]) : null
Parameters
$data : array<string|int, mixed>
  • Array with parameters
$exceptions : array<string|int, mixed> = []
  • Array with exceptions keys
Return values
null —

delete()

Delete customer if its a private customer or delete his store´s relashionship if is public

public delete(Request $request, int $id) : string
Parameters
$request : Request
  • Datas of the object that we want to update.
$id : int
  • Id of the store that we want to update.
Return values
string —

deleteChild()

public deleteChild(Request $request, mixed $parent_id, int $id) : bool
Parameters
$request : Request
$parent_id : mixed
$id : int
  • Id of the object that we want to remove.
Tags
desc

Remove record from the database (Soft)

Return values
bool —
  • Success or fail

ensureHttp400Code()

Return a extension from mimetype

public ensureHttp400Code(mixed $code) : string
Parameters
$code : mixed
Return values
string —

firstOrCreate()

public firstOrCreate(Request $request) : object
Parameters
$request : Request
Tags
desc

Create a new record in the database

Return values
object —

firstOrNew()

public firstOrNew(Request $request) : object
Parameters
$request : Request
Tags
desc

Create a new record in the database

Return values
object —

forceDelete()

public forceDelete(Request $request, int $id) : bool
Parameters
$request : Request
$id : int
  • Id of the object that we want to remove.
Tags
desc

Remove record from the database

Return values
bool —
  • Success or fail

getCustomLabelFormat()

Return an array with custom label format

public getCustomLabelFormat(string $customLabel[, array<string|int, mixed> $data = NULL ]) : array<string|int, mixed>
Parameters
$customLabel : string
  • New response label
$data : array<string|int, mixed> = NULL
  • Response datas
Return values
array<string|int, mixed> —

getErrorResponse()

Return all an array of errors like validation in one format

public getErrorResponse(mixed $message[, mixed $code = null ]) : array<string|int, mixed>
Parameters
$message : mixed
$code : mixed = null
Return values
array<string|int, mixed> —

getFailResponse()

Return all an array of errors like validation in one format

public getFailResponse(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
  • Array with parameters
Return values
array<string|int, mixed> —

getModel()

public getModel() : Model
Tags
desc

Get the associated model

Return values
Model —

$model - A specific model

getObject()

public getObject(mixed $id) : array<string|int, mixed>
Parameters
$id : mixed
Tags
desc

Get instances of model

Return values
array<string|int, mixed> —

getSuccessResponse()

Return all an array of errors like validation in one format

public getSuccessResponse([array<string|int, mixed> $data = "" ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed> = ""
  • Array with parameters
Return values
array<string|int, mixed> —

getUserStore()

public getUserStore() : mixed
Tags
desc

Get user store for employees and managers roles

Return values
mixed —

mime2ext()

Return a extension from mimetype

public mime2ext(string $mime) : string
Parameters
$mime : string
  • String with mimetype
Return values
string —

orderQuery()

Destroy record from the database

public orderQuery(mixed &$query, array<string|int, mixed> $params) : null
Parameters
$query : mixed
$params : array<string|int, mixed>
  • Array with the pagination params
Return values
null —

paginate()

Show all store´s customers paginated

public paginate(Request $request) : array<string|int, mixed>
Parameters
$request : Request
Return values
array<string|int, mixed> —

paginateChild()

public paginateChild(Request $request, mixed $parent_id) : array<string|int, mixed>
Parameters
$request : Request
$parent_id : mixed
Tags
desc

Get all instances of model paginate

Return values
array<string|int, mixed> —

setModel()

public setModel(Model $model) : mixed
Parameters
$model : Model
  • A specific model
Tags
desc

Set the associated model

Return values
mixed —

show()

Show one store´s customer given by id

public show(Request $request, int $id) : array<string|int, mixed>
Parameters
$request : Request
$id : int
  • Customer's Id to be shown
Return values
array<string|int, mixed> —

showChild()

public showChild(Request $request, mixed $parent_id, int $id) : object
Parameters
$request : Request
$parent_id : mixed
$id : int
  • Id of the object that we want to show.
Tags
desc

Show the record with the given id

Return values
object —

store()

Customer record from the database

public store(Request $request) : string
Parameters
$request : Request
  • Datas of the object that we want to update.
Return values
string —

storeChild()

public storeChild(Request $request, mixed $parent_id) : object
Parameters
$request : Request
$parent_id : mixed
Tags
desc

Create a new record in the database

Return values
object —

update()

public update(Request $request, int $id) : string
Parameters
$request : Request
  • Datas of the object that we want to update.
$id : int
  • id from the customer who want update
Tags
desc

Update record from the database

Return values
string —

updateChild()

public updateChild(Request $request, mixed $parent_id, int $id) : object
Parameters
$request : Request
$parent_id : mixed
$id : int
  • Id of the object that we want to update.
Tags
desc

Update record in the database

Return values
object —

getConcatString()

Concatenate string to make it compatible with SQLite

private getConcatString( $firstField,  $secondField) : string
Parameters
$firstField :
$secondField :
Return values
string —

lookForCustomers()

Used when creating customers to look for existing customer from other stores or public users

private lookForCustomers(Request $request) : Customer|null
Parameters
$request : Request
Return values
Customer|null —

storePivotAttributte()

Stores attribute in pivot table customers_stores

private storePivotAttributte(object $customer, string $attribute, mixed $value) : mixed
Parameters
$customer : object

customer to update

$attribute : string
$value : mixed
Return values
mixed —

Search results