Index | Eladmin Docs

A

Module::authorize() — Method in class Module: Check if user is logged in. Also check if user has one of the $authorizedRoles (if specified).
Module::accountUpdate() — Method in class Module: Eladmin calls this method during profile update.
Module::accountFields() — Method in class Module: Return an array of profile fields in the form of field_name=>[label=>input label, type=>input_type] Retrurn null if Eladmin edit profile dialog should be disabled.
Module::actionAuthorizedDelete() — Method in class Module
Module::actionDelete() — Method in class Module: ACTION. Hard delete.
Password::authorize() — Method in class Password: Check if user is logged in. Also check if user has one of the $authorizedRoles (if specified).
Password::accountFields() — Method in class Password: Return an array of profile fields in the form of field_name=>[label=>input label, type=>input_type] Retrurn null if Eladmin edit profile dialog should be disabled.
Password::accountUpdate() — Method in class Password: Eladmin calls this method during profile update.
Child::after() — Method in class Child: Place child just after $target.
$Core#auth — Property in class Core: override to use advanced authorization, set to null to disable authorization completely
$Core#assetCacheExpiration — Property in class Core: asset cache expiration in secs
$Core#actionkey — Property in class Core: requested action key
$Core#allModulesInitialized — Property in class Core
Core::actionkey() — Method in class Core: Return requested action key, null if no action requested
Core::assetpath() — Method in class Core: Return requested asset path, null if no asset requested
Core::accountFields() — Method in class Core
Core::actionAccountUpdate() — Method in class Core
Core::actionAccountForm() — Method in class Core
IAuth::accountFields() — Method in class IAuth: Return an array of profile fields in the form of field_name=>[label=>input label, type=>input_type] Retrurn null if Eladmin edit profile dialog should be disabled.
IAuth::accountUpdate() — Method in class IAuth: Eladmin calls this method during profile update.
IAuth::authorize() — Method in class IAuth: Check if user is logged in. Also check if user has one of the $authorizedRoles (if specified).
$Module#actionRoles — Property in class Module: override to set authorized roles
$Module#actionsParsed — Property in class Module: normalizing action names for elaActionRoles is expensive, we want to do it only once
Module::auth() — Method in class Module: Check if user is authorized to do action, or athorized to access module at all.
Module::assetUrl() — Method in class Module: Create asset url, file path relative to /assets directory. Default $version = eladmin version
Module::actions() — Method in class Module: Return array of all defined actions.
Action — Class in namespace Onspli\Eladmin\Modules\Crud\Chainset
Actions — Class in namespace Onspli\Eladmin\Modules\Crud\Chainset
Crud::actionCreateForm() — Method in class Crud: ACTION. Show form - create entry.
Crud::actionUpdateForm() — Method in class Crud: ACTION. Show form - edit entry.
Crud::actionRead() — Method in class Crud: ACTION. List database entries.
Crud::actionUpdate() — Method in class Crud: ACTION. Edit database entry.
Crud::actionCreate() — Method in class Crud: ACTION. Create database entry.
Crud::actionDelete() — Method in class Crud: ACTION. Hard delete.
Crud::actionSoftDelete() — Method in class Crud: ACTION. Soft delete.
Crud::actionRestore() — Method in class Crud: ACTION. Restore.

B

Child::before() — Method in class Child: Place child just before $target.
Core::blade() — Method in class Core: Return Blade instance
BadRequestException — Class in namespace Onspli\Eladmin\Exception
Module::blade() — Method in class Module: Return Blade instance
$Action#bulk — Property in class Action: Enable as bulk action.
Action::bulk() — Method in class Action: Bulk action

C

Module::crudActions() — Method in class Module: Default actions chainset. Override to configure actions.
Module::crudColumns() — Method in class Module: Default columns setting.
User::createTable() — Method in class User
Chainset — Class in namespace Onspli\Eladmin\Chainset: Chainset object is funny method to configure things.
$Chainset#childClass — Property in class Chainset
$Chainset#children — Property in class Chainset
Chainset::cutChild() — Method in class Chainset: Remove child from linked list.
Chainset::current() — Method in class Chainset
Child — Class in namespace Onspli\Eladmin\Chainset: Chainset object is funny method to configure things.
Core — Class in namespace Onspli\Eladmin: Eladmin core class.
$Core#cache — Property in class Core: override to set Blade cache directory
Core::CSRFToken() — Method in class Core: Generate CSRF token
Core::CSRFAuth() — Method in class Core: Check if CSRF token is valid
$Module#core — Property in class Module: Eladmin core instance
Module::core() — Method in class Module: Return core instance
$Action#confirm — Property in class Action: Confirmation question string.
Action::confirm() — Method in class Action: Confirm.
$Actions#childClass — Property in class Actions
Column — Class in namespace Onspli\Eladmin\Modules\Crud\Chainset
Columns — Class in namespace Onspli\Eladmin\Modules\Crud\Chainset
$Columns#childClass — Property in class Columns
$Filter#column — Property in class Filter
$Filters#childClass — Property in class Filters
Crud — Class in namespace Onspli\Eladmin\Modules\Crud: Generic CRUD module.
$Crud#crudColumns — Property in class Crud: Columns chainset class
$Crud#crudActions — Property in class Crud: Actions chainset class
$Crud#crudFilters — Property in class Crud: Filters chainset class
$Crud#crudColumnsCached — Property in class Crud: Cached columns chainset
$Crud#crudActionsCached — Property in class Crud: Cached actions chainset;
$Crud#crudFiltersCached — Property in class Crud: Cached filters chainset.
Crud::create() — Method in class Crud: IMPLEMENT. Create item.
Crud::crudColumns() — Method in class Crud: IMPLEMENT. Default columns chainset. Override to configure columns.
Crud::crudActions() — Method in class Crud: Default actions chainset. Override to configure actions.
Crud::crudFilters() — Method in class Crud: Default filters chainset. Override to configure filters.
Column — Class in namespace Onspli\Eladmin\Modules\Eloquent\Chainset
Columns — Class in namespace Onspli\Eladmin\Modules\Eloquent\Chainset
$Columns#childClass — Property in class Columns
Crud — Class in namespace Onspli\Eladmin\Modules\Eloquent: Crud module for Eloquent model.
$Crud#crudColumns — Property in class Crud
Crud::create() — Method in class Crud: IMPLEMENT. Create item.
Crud::crudColumns() — Method in class Crud: Default columns setting.

D

$Action#done — Property in class Action: JS code to be executed when action ends successfully.
Action::done() — Method in class Action: JS to be done after action.
Action::danger() — Method in class Action: Style - danger
$Column#desc — Property in class Column: Column description.
$Column#disabled — Property in class Column: Can we edit the value in the form?
$Column#default — Property in class Column: columns default value
Column::default() — Method in class Column: Set default value
Column::disabled() — Method in class Column: Disable editing column's value.
$Crud#defaults — Property in class Crud: Default crud request
Crud::default() — Method in class Crud: Read default row Returns row as an associative array ['columnName' => 'value']
Crud::delete() — Method in class Crud: IMPLEMENT. Hard delete row.
Crud::defaults() — Method in class Crud: set defaults
Column::datetime() — Method in class Column
Crud::delete() — Method in class Crud: IMPLEMENT. Hard delete row.

E

Core::errorHandler() — Method in class Core
Exception — Class in namespace Onspli\Eladmin\Exception
$Module#elakey — Property in class Module: Module's elakey
Module::elakey() — Method in class Module: Each module has its elakey - index in modules array - used to address requests.
$Action#editable — Property in class Action: Show action in edit form.
Action::editable() — Method in class Action: Show in edit form
$Column#editable — Property in class Column: Should we show the column in the edit form?
Column::evalProperty() — Method in class Column: Eval property
Column::escaped() — Method in class Column: Output escaped value.
Column::editable() — Method in class Column: Show the column in the edit form.
Column::enabled() — Method in class Column: Enable editing column's value.

F

$Chainset#first — Property in class Chainset
Core::firstAuthorizedModuleKey() — Method in class Core: return first authorized module key
$Action#form — Property in class Action: Improper action - it generates form.
$Action#filter — Property in class Action: Callback to determinate if the action should be visible for a particular item.
Action::filter() — Method in class Action: Filter.
Action::form() — Method in class Action: Form action.
Filter — Class in namespace Onspli\Eladmin\Modules\Crud\Chainset
Filters — Class in namespace Onspli\Eladmin\Modules\Crud\Chainset

G

Chainset::getFirst() — Method in class Chainset
Chainset::getLast() — Method in class Chainset
Action::getName() — Method in class Action: Get normalized name of action
Action::getAction() — Method in class Action
$Column#getformat — Property in class Column: format for editing
Column::getName() — Method in class Column: Get internal name of the column.
Column::getValue() — Method in class Column: Extract value of the column from $row array
Column::get() — Method in class Column: Format for editing
Columns::getConfig() — Method in class Columns: generate array of actions for one column
Crud::get() — Method in class Crud: IMPLEMENT. Read one row.
Crud::getCrudColumns() — Method in class Crud: Get columns chainset.
Crud::getCrudActions() — Method in class Crud: Get actions chainset.
Crud::getCrudFilters() — Method in class Crud: Get filters chainset.
Crud::get() — Method in class Crud: IMPLEMENT. Read one row.

H

Module::hasAction() — Method in class Module: Check if actions is defined.
Action::hidden() — Method in class Action: Shortcut for nonlistable && noneditable
Column::hidden() — Method in class Column: Shortcut for nonlistable && noneditable && disabled

I

$Module#icon — Property in class Module
$Password#isPasswordFileWriteable — Property in class Password
$Core#imodules — Property in class Core: modules instances
$Core#iauth — Property in class Core: authorization instance
Core::iauth() — Method in class Core: Return authorization instance.
Core::isAjaxRequest() — Method in class Core: Check if eladmin was run with ajax request.
Core::initLocalization() — Method in class Core
Core::initSessions() — Method in class Core
Core::initCache() — Method in class Core
Core::initAuthorization() — Method in class Core
Core::initAllModules() — Method in class Core
Core::initMonolog() — Method in class Core
IAuth — Class in namespace Onspli\Eladmin
$Module#icon — Property in class Module: override to set module's icon
Module::icon() — Method in class Module: Get icon of the module.
Module::isAction() — Method in class Module: Check if actions is executed.
$Action#icon — Property in class Action: Action icon
$Column#input — Property in class Column: Input type for the column editation.
Column::input() — Method in class Column: Set the type of input.
$Filter#input — Property in class Filter
$Filter#icon — Property in class Filter
Crud::implementsSoftDeletes() — Method in class Crud: IMPLEMENT. Does CRUD use soft deletes?
Crud::implementsSearch() — Method in class Crud: IMPLEMENT. Does CRUD support searching?
Crud::implementsPaging() — Method in class Crud: IMPLEMENT. Does CRUD support paging?
Crud::implementsSorting() — Method in class Crud: IMPLEMENT. Does CRUD support sorting?
Crud::implementsFilters() — Method in class Crud: IMPLEMENT. Does CRUD support filtering?
Crud::id() — Method in class Crud: Return ID of the row which should be affected by the action.
$Crud#imodel — Property in class Crud: Model instance
Crud::implementsSoftDeletes() — Method in class Crud: IMPLEMENT. Does CRUD use soft deletes?
Crud::implementsSorting() — Method in class Crud: IMPLEMENT. Does CRUD support sorting?
Crud::implementsPaging() — Method in class Crud: IMPLEMENT. Does CRUD support paging?
Crud::implementsSearch() — Method in class Crud: IMPLEMENT. Does CRUD support searching?
Crud::implementsFilters() — Method in class Crud: IMPLEMENT. Does CRUD support filtering?

K

Chainset::key() — Method in class Chainset
$Child#key — Property in class Child

L

Module::loginFields() — Method in class Module: Return an array of login fields in the form of field_name=>[label=>input label, type=>input_type] Retrurn null if Eladmin login dialog should be disabled (and you want to do authentication on your own)
Module::login() — Method in class Module: Eladmin calls this method during authentication.
Module::logout() — Method in class Module: Logout.
Password::loginFields() — Method in class Password: Return an array of login fields in the form of field_name=>[label=>input label, type=>input_type] Retrurn null if Eladmin login dialog should be disabled (and you want to do authentication on your own)
Password::login() — Method in class Password: Eladmin calls this method during authentication.
Password::logout() — Method in class Password: Logout.
$Chainset#last — Property in class Chainset
$Core#lang — Property in class Core: override to set language
$Core#logLevel — Property in class Core: override to set monolog report level, null disables logging
$Core#logFile — Property in class Core: override to set monolog log file
$Core#log — Property in class Core: monolog Logger
Core::log() — Method in class Core: monolog Logger
IAuth::loginFields() — Method in class IAuth: Return an array of login fields in the form of field_name=>[label=>input label, type=>input_type] Retrurn null if Eladmin login dialog should be disabled (and you want to do authentication on your own)
IAuth::login() — Method in class IAuth: Eladmin calls this method during authentication.
IAuth::logout() — Method in class IAuth: Logout.
$Action#label — Property in class Action: Action label.
$Action#listable — Property in class Action: Show action in crud table.
Action::listable() — Method in class Action: Show in crud table
$Column#label — Property in class Column: Column label.
$Column#listable — Property in class Column: Should we show the column in the table?
$Column#limit — Property in class Column: Max length of value to be shown in the table.
$Column#listformat — Property in class Column: fromat for listing
Column::listable() — Method in class Column: Show the column in the table.
Column::limit() — Method in class Column: Max length of value to be shown in the table.
Column::list() — Method in class Column: Format for listing
$Filter#label — Property in class Filter

M

Module — Class in namespace Onspli\Eladmin\Auth\EloquentUser
$Module#model — Property in class Module
$Core#modules — Property in class Core: override to register admin modules
$Core#modulekey — Property in class Core: requested module elakey
Core::modulekey() — Method in class Core: Return requested module key, null if no module requested
Core::module() — Method in class Core: Return module instance or null if not authorized. Default $key = modulekey()
Core::modules() — Method in class Core: Return instances of all authorized modules.
Module — Class in namespace Onspli\Eladmin: Generic Eladmin module.
Crud::modify() — Method in class Crud: modify values before update
$Crud#model — Property in class Crud: Model class name. Must be overriden.
Crud::model() — Method in class Crud: Return model instance for action.

N

Chainset::next() — Method in class Chainset
$Child#next — Property in class Child
Action::nonbulk() — Method in class Action: Not a bulk action
Action::nonform() — Method in class Action: Not form action
Action::nonlistable() — Method in class Action: Do not show in crud table
Action::noneditable() — Method in class Action: Do not show in edit form
Column::nonlistable() — Method in class Column: Do not show the column in the table.
Column::nonsearchable() — Method in class Column: Do not use the column for searching.
Column::nonsortable() — Method in class Column: Do not sort by the column.
Column::noneditable() — Method in class Column: Hide the column in the edit form.

P

$Module#possibleRoles — Property in class Module: List of possible roles in format [ => , .
Password — Class in namespace Onspli\Eladmin\Auth: Simple username/password authorization.
$Password#password — Property in class Password
$Password#passwordFile — Property in class Password
$Password#passwordHash — Property in class Password
$Chainset#position — Property in class Chainset
$Child#parent — Property in class Child
$Child#prev — Property in class Child
Module::prepare() — Method in class Module: Runs before any action is executed.
Module::parseAction() — Method in class Module: We want action keys to be case insensitive. This converts action to lowercase.
Action::primary() — Method in class Action: Style - primary
Column::password() — Method in class Column: Set the type of input to password Add nonlistable flag
Crud::primary() — Method in class Crud: IMPLEMENT. Name of primary key column. Default is 'id'.
Crud::prepare() — Method in class Crud: Runs before any action is executed.
Crud::primary() — Method in class Crud: Primary column name.
Crud::prepare() — Method in class Crud: Prepare action. Initialise model() with the requested db entry.

R

$Module#roles — Property in class Module
Chainset::rewind() — Method in class Chainset
Core::run() — Method in class Core: Run Eladmin. It's just a wrapper of method runNoCatch catching exceptions.
Core::runNoCatch() — Method in class Core: Run Eladmin. The main function which processes the requests.
Core::renderAsset() — Method in class Core: Determinate asset content-type and render it.
Core::redirect() — Method in class Core: Redirect (or exit if ajax request). Default url = home
$Module#roles — Property in class Module: override to set authorized roles
Module::requestUrl() — Method in class Module: Return url for this module.
Module::roles() — Method in class Module: Get roles authorized to work with the module, or specific action. Empty array means any role is authorized.
Module::render() — Method in class Module: Return rendered view.
Module::renderAsset() — Method in class Module: Determinate asset content-type and render it.
Module::renderText() — Method in class Module: Convinient method for plain text output. Sets HTTP header text/plain and echo $str.
Module::renderHtml() — Method in class Module: Convinient method for html output. Sets HTTP header text/html and echo $str.
Module::renderJson() — Method in class Module: Convinient method for json output. Sets HTTP header application/json and echo serialized $json.
$Column#raw — Property in class Column: Should we excape the value of the column?
Column::raw() — Method in class Column: Output raw value (i.e. HTML)
Crud::restore() — Method in class Crud: IMPLEMENT. Restore soft deleted row.
Crud::read() — Method in class Crud: IMPLEMENT. Fetch an array of rows.
Crud::rowValuesArray() — Method in class Crud: generate array of values for one row
Crud::rowActionsArray() — Method in class Crud: generate array of actions for one item
Crud::read() — Method in class Crud: IMPLEMENT. Fetch an array of rows.
Crud::restore() — Method in class Crud: IMPLEMENT. Restore soft deleted row.

S

User::setPasswordhashAttribute() — Method in class User
Chainset::setFirst() — Method in class Chainset
Chainset::setLast() — Method in class Chainset
Module::setRoles() — Method in class Module: Set roles authorized to work with the module, or specific action. Empty array means any role is authorized.
$Action#style — Property in class Action: Action style.
Action::secondary() — Method in class Action: Style . secondary
Action::success() — Method in class Action: Style - success
$Column#searchable — Property in class Column: Should we use this column for searching?
$Column#sortable — Property in class Column: Can we sort the table by this column?
$Column#setformat — Property in class Column: format for updating
Column::searchable() — Method in class Column: Use the column for searching.
Column::sortable() — Method in class Column: Use the column for sorting.
Column::select() — Method in class Column: Set the type of input to select.
Column::set() — Method in class Column: Format user input for updating the entry
$Filter#selectOptions — Property in class Filter
Filter::select() — Method in class Filter
Crud::softDelete() — Method in class Crud: IMPLEMENT. Soft delete row.
Crud::softDelete() — Method in class Crud: IMPLEMENT. Soft delete row.

T

$Module#title — Property in class Module
Module::title() — Method in class Module: Get name of the module.
$User#table — Property in class User
$Core#title — Property in class Core: override to set administration title
$Core#t — Property in class Core: gettext translator
Core::title() — Method in class Core: Return administration title to show it in templates.
$Module#title — Property in class Module: override to set module's name
Module::title() — Method in class Module: Get name of the module.
Column::textarea() — Method in class Column: Set the type of input to textarea.
Crud::tableColumns() — Method in class Crud: Get an array of table columns.

U

Module::unauthorized() — Method in class Module: This method is called when user is not autorized and loginFileds returns null.
Module::user() — Method in class Module
Module::userName() — Method in class Module: Get user's name to show it in admin.
User — Class in namespace Onspli\Eladmin\Auth\EloquentUser
$Password#username — Property in class Password
Password::unauthorized() — Method in class Password: This method is called when user is not autorized and loginFileds returns null.
Password::userName() — Method in class Password: Get user's name to show it in admin.
Core::username() — Method in class Core: Returns username to show it in templates. Returns null if authorization is off.
UnauthorizedException — Class in namespace Onspli\Eladmin\Exception
IAuth::unauthorized() — Method in class IAuth: This method is called when user is not autorized and loginFileds returns null.
IAuth::userName() — Method in class IAuth: Get user's name to show it in admin.
Crud::update() — Method in class Crud: IMPLEMENT. Update item.
Crud::unset() — Method in class Crud: unset columns which we shouldn't recieve before update
Crud::updateOrCreate() — Method in class Crud: Update or create entry.
Crud::update() — Method in class Crud: IMPLEMENT. Update item.

V

Chainset::valid() — Method in class Chainset
$Core#views — Property in class Core: override to extend blade views directory
Core::version() — Method in class Core: Get eladmin version.
Core::views() — Method in class Core: Extends array of directories of views and assets.
$Module#views — Property in class Module: Add views directory to module;
Module::views() — Method in class Module: Extends array of directories of views and assets.
$Column#validate — Property in class Column: validation callback
Column::validate() — Method in class Column: Validate user input
Crud::views() — Method in class Crud: Extends array of directories of views and assets.
Crud::validate() — Method in class Crud: validate columns before update

W

Action::warning() — Method in class Action: Style - warning

_

User::__construct() — Method in class User
Password::__construct() — Method in class Password
Chainset::__construct() — Method in class Chainset
Chainset::__isset() — Method in class Chainset
Chainset::__unset() — Method in class Chainset
Chainset::__get() — Method in class Chainset
Child::__call() — Method in class Child
Child::_setKey() — Method in class Child
Child::_getKey() — Method in class Child
Child::_setNext() — Method in class Child
Child::_getNext() — Method in class Child
Child::_setPrev() — Method in class Child
Child::_getPrev() — Method in class Child
Child::_setParent() — Method in class Child
Child::_getParent() — Method in class Child
Core::__construct() — Method in class Core: Each module has to be initialized with eladmin instance and its own elakey.
BadRequestException::__construct() — Method in class BadRequestException
Exception::__construct() — Method in class Exception
UnauthorizedException::__construct() — Method in class UnauthorizedException
Module::__construct() — Method in class Module: Each module has to be initialized with eladmin instance and its own elakey.
Actions::__isset() — Method in class Actions
Actions::__unset() — Method in class Actions
Actions::__get() — Method in class Actions