\Alddesign\Crudkit\ControllersCrudkitController

Crudkit Controller

Contains code for all the endpoints defined in rountes.php.

Summary

Methods
Properties
Constants
__construct()
init()
autoGenerate()
index()
listView()
cardView()
updateView()
createView()
chartView()
messageView()
loginView()
backup()
deleteRecord()
createRecord()
updateRecord()
login()
logout()
setTheme()
action()
exportRecordsCsv()
exportRecordsXml()
getChartData()
ajaxManyToOne()
ajaxCustom()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
csvLookup()
getHtmlInputAttributes()
$version
$pageStore
$authHelper
N/A

Properties

$version

$version : string

Type

string — The CRUDKit version.

Methods

__construct()

__construct() 

Creates a new controller instance

init()

init(\Alddesign\Crudkit\Controllers\PageStroe  $pageStore, \Alddesign\Crudkit\Classes\AuthHelper  $authHelper = null) 

Set pages and authHelper.

Parameters

\Alddesign\Crudkit\Controllers\PageStroe $pageStore
\Alddesign\Crudkit\Classes\AuthHelper $authHelper

autoGenerate()

autoGenerate(\Illuminate\Http\Request  $request) 

Automatic generation of a CurdkitServiceProvider.php

Parameters

\Illuminate\Http\Request $request

index()

index(\Illuminate\Http\Request  $request) 

Brings up the startpage or login view, if not logged in

Parameters

\Illuminate\Http\Request $request

listView()

listView(\Illuminate\Http\Request  $request) : \Illuminate\Http\Response

Displays records as a summary/list page

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\Response

cardView()

cardView(\Illuminate\Http\Request  $request) : \Illuminate\Http\Response

Displays a singe recorda as a card page

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\Response

updateView()

updateView(\Illuminate\Http\Request  $request) : \Illuminate\Http\Response

The view for editing an existing record.

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\Response

createView()

createView(\Illuminate\Http\Request  $request) : \Illuminate\Http\Response

The view for creating a new record.

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\Response

chartView()

chartView(\Illuminate\Http\Request  $request) : \Illuminate\Http\Response

Displays records as a chart

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\Response

messageView()

messageView(\Illuminate\Http\Request  $request) : \Illuminate\Http\Response

Message page

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\Response

loginView()

loginView(\Illuminate\Http\Request  $request) : \Illuminate\Http\Response

Login page

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\Response

backup()

backup(\Illuminate\Http\Request  $request) : string

Automated backup endpoint. Should be called via Cronjob - see crudkit config for setup.

Parameters

\Illuminate\Http\Request $request

Returns

string

deleteRecord()

deleteRecord(\Illuminate\Http\Request  $request) : \Illuminate\Http\RedirectResponse

Deletes a record from the database

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\RedirectResponse

createRecord()

createRecord(\Illuminate\Http\Request  $request) : \Illuminate\Http\RedirectResponse

Creates a record

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\RedirectResponse

updateRecord()

updateRecord(\Illuminate\Http\Request  $request) : \Illuminate\Http\RedirectResponse

Updates a record

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\RedirectResponse

login()

login(\Illuminate\Http\Request  $request) : \Illuminate\Http\RedirectResponse

Performs the login

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\RedirectResponse

logout()

logout(\Illuminate\Http\Request  $request) : \Illuminate\Http\RedirectResponse

Performs the logout

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\RedirectResponse

setTheme()

setTheme(\Illuminate\Http\Request  $request) 

Parameters

\Illuminate\Http\Request $request

action()

action(\Illuminate\Http\Request  $request) : \Illuminate\Http\RedirectResponse

Executes a predefined callback action for a specific page (action button)

Parameters

\Illuminate\Http\Request $request

Returns

\Illuminate\Http\RedirectResponse

exportRecordsCsv()

exportRecordsCsv(\Illuminate\Http\Request  $request) 

Exports a page as CSV (including filters and search but). Ignores limitatin by pagination,

Parameters

\Illuminate\Http\Request $request

exportRecordsXml()

exportRecordsXml(\Illuminate\Http\Request  $request) 

Exports a page as XML (including filters and search but). Ignores limitatin by pagination,

Parameters

\Illuminate\Http\Request $request

getChartData()

getChartData(\Illuminate\Http\Request  $request) : string

Creates Chart data based on the page, filters and search in form ob a JSON object.

Called via Javascript.

Parameters

\Illuminate\Http\Request $request

Returns

string —

Chart data as json object (for javascript)

ajaxManyToOne()

ajaxManyToOne() 

ajaxCustom()

ajaxCustom() 

csvLookup()

csvLookup(\Alddesign\Crudkit\Controllers\bool  $header, \Alddesign\Crudkit\Controllers\bool  $exportLookups, array  $lookups, \Alddesign\Crudkit\Controllers\string  $position, \Alddesign\Crudkit\Controllers\string  $columnName, array  $line) 

Parameters

\Alddesign\Crudkit\Controllers\bool $header
\Alddesign\Crudkit\Controllers\bool $exportLookups
array $lookups
\Alddesign\Crudkit\Controllers\string $position
\Alddesign\Crudkit\Controllers\string $columnName
array $line

getHtmlInputAttributes()

getHtmlInputAttributes(array<mixed,\Alddesign\Crudkit\Classes\SQLColumn>  $columns) : string

Fetches all columns (no data) an crates necessary html <input> attributes. Such as "readonly".

Parameters

array<mixed,\Alddesign\Crudkit\Classes\SQLColumn> $columns

Returns

string —

$htmlInputAttributes