SALT SSO v1.1.0
Back to top  

Parent class for all Administrable objects

package sso\view\admin

 Methods

Add an error message

addError(string $error) 

Parameters

$error

string

error message

Add a report message

addMessage(string $message) 

Parameters

$message

string

report message

Build a object that will be passed to all FORM method

buildViewContext(\salt\DBResult $data) : NULL | array<mixed,mixed>

Can be used for pre-load data for all rows

Parameters

$data

\salt\DBResult

all objects

Returns

NULLarray<mixed,mixed>array key => value

Create a new object from form data

createFrom(array<mixed,mixed> $data) : \salt\Base

Parameters

$data

array<mixed,mixed>

key => value

Returns

\salt\Basenew object

The text to display for object

displayName(\salt\Base $obj) : string

Parameters

$obj

\salt\Base

object

Returns

stringthe object name or id

Check has an error

hasErrors() : boolean

Returns

booleanTRUE if addError() was called

Retrieve delete queries on other objects to execute when delete object

relatedObjectsDeleteQueries(\salt\Base $obj) : array<mixed,\salt\DeleteQuery>

Parameters

$obj

\salt\Base

the object to delete

Returns

array<mixed,\salt\DeleteQuery>delete queries

Retrieve delete queries to execute after an update

relatedObjectsDeleteQueriesAfterUpdate(\sso\SsoGroupElement $template, array $existingIds, array $deleteIds) : array<mixed,\salt\DeleteQuery>

Parameters

$template

\sso\SsoGroupElement

object to delete with some field setted

$existingIds

array

existing elements id

$deleteIds

array

deleted elements id

Returns

array<mixed,\salt\DeleteQuery>delete queries

Retrieve insert queries to execute after an update

relatedObjectsInsertQueriesAfterUpdate(\sso\SsoGroupElement $template, array $existingIds, array $newIds) : array<mixed,\salt\InsertQuery>

Parameters

$template

\sso\SsoGroupElement

object to insert with some field setted

$existingIds

array

existing elements id

$newIds

array

new elements id

Returns

array<mixed,\salt\InsertQuery>insert queries

Update an object

updateFrom(\salt\Base $obj, array<mixed,mixed> $data) : \salt\Base

Parameters

$obj

\salt\Base

the object to update

$data

array<mixed,mixed>

key => value

Returns

\salt\Basemodified object or NULL if data not valid

 Properties

 

list of errors

$errors : array<mixed,string>

Default

array()
 

list of extra field name to display

$extraFields : array<mixed,string>

Default

NULL
 

list of field name to NOT display

$hideFields : array<mixed,string>

Default

array()
 

list of messages

$messages : array<mixed,string>

Default

array()
 

list of field name that can be modified

$modifiableFields : array<mixed,string>

Default

NULL
 

list of field name that can be set in the new row

$newFields : array<mixed,string>

Default

NULL
 

singleton of object

$object : \salt\Base

Default

NULL
 

list of field name for filter

$searchFields : array<mixed,string>

Default

NULL
 

Title of the admin object page

$title : string

Default

NULL
 

list of field name to display in tooltip

$tooltipFields : array<mixed,string>

Default

array()