SALT SSO v1.0.0 » \sso\SsoGroupAdmin

Class for Group admin

package	sso\view\admin
inherited_from	\sso\SsoAdmin

Methods

Build a new Group admin class

__construct()

Add an error message

addError(string $error)

Inherited

Parameters

$error

string

error message

Add a report message

addMessage(string $message)

Inherited

Parameters

$message

string

report message

Build a object that will be passed to all FORM method

buildViewContext(\salt\DBResult $data)

Can be used for pre-load data for all rows

see
inherited_from	\sso\SsoAdmin::buildViewContext()

Parameters

$data

\salt\DBResult

all objects

Build a object that will be passed to all FORM method

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

Inherited

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)

see
inherited_from	\sso\SsoAdmin::createFrom()

Parameters

$data

array<mixed,mixed>

key => value

Create a new object from form data

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

Inherited

Parameters

$data

array<mixed,mixed>

key => value

Returns

\salt\Basenew object

The text to display for object

displayName(\salt\Base $obj)

see
inherited_from	\sso\SsoAdmin::displayName()

Parameters

$obj

\salt\Base

object

The text to display for object

displayName(\salt\Base $obj) : string

Inherited

Parameters

$obj

\salt\Base

object

Returns

stringthe object name or id

Check has an error

hasErrors() : boolean

Inherited

Returns

booleanTRUE if addError() was called

Retrieve delete queries on other objects to execute when delete object

relatedObjectsDeleteQueries(\salt\Base $obj)

see
inherited_from	\sso\SsoAdmin::relatedObjectsDeleteQueries()

Parameters

$obj

\salt\Base

the object to delete

Retrieve delete queries on other objects to execute when delete object

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

Inherited

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)

see
inherited_from	\sso\SsoAdmin::relatedObjectsDeleteQueriesAfterUpdate()

Parameters

$template

\sso\SsoGroupElement

object to delete with some field setted

$existingIds

array

existing elements id

$deleteIds

array

deleted elements id

Retrieve delete queries to execute after an update

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

Inherited

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)

see
inherited_from	\sso\SsoAdmin::relatedObjectsInsertQueriesAfterUpdate()

Parameters

$template

\sso\SsoGroupElement

object to insert with some field setted

$existingIds

array

existing elements id

$newIds

array

new elements id

Retrieve insert queries to execute after an update

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

Inherited

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)

see
inherited_from	\sso\SsoAdmin::updateFrom()

Parameters

$obj

\salt\Base

the object to update

$data

array<mixed,mixed>

key => value

Update an object

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

Inherited

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()

types of groupable element : key => SsoGroupElement::TYPE_*

$types : array<mixed,integer>

Default

array('users' => \sso\SsoGroupElement::TYPE_USER, 'applis' => \sso\SsoGroupElement::TYPE_APPLI, 'auths' => \sso\SsoGroupElement::TYPE_AUTH)

Static