Class Atk4\Ui\JsCallback

`extends`	`Callback`

Atk4\Ui\AbstractView uses AppScopeTrait, ContainerTrait, InitializerTrait, NameTrait, StaticAddToTrait, TrackableTrait
- Atk4\Ui\Callback
  - Atk4\Ui\JsCallback
    - Atk4\Ui\JsPaginator
    - Atk4\Ui\Table\Column\JsHeaderDropdownCallback
    - Atk4\Ui\JsSortable
    - Atk4\Ui\UserAction\JsCallbackExecutor implements ExecutorInterface uses HookTrait
    - Atk4\Ui\JsSse uses HookTrait

Located at ui/src/JsCallback.php

Methods


					
	public

jsExecute(): JsBlock

Overriden by


					
	public

setConfirm(string $text = 'Are you sure?'): void

Set a confirmation to be displayed before actually sending a request.


					
	public

set(
	Closure(Jquery, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed): (JsExpressionable|View|string|void) $fx = null,
	$args = null,
): $this

Executes user-specified action when callback is triggered.

Overrides

Atk4\Ui\Callback::set()

Overriden by

Atk4\Ui\JsSse::set()


					
	public

terminateAjax(string|null $ajaxec, ($success is true ? null : string) $msg = null, bool $success = true): void

A proper way to finish execution of AJAX response. Generates JSON which is returned to frontend.

Parameters

`$msg`	General message, typically won't be displayed
`$success`	Was request successful or not

Overriden by

Atk4\Ui\JsSse::terminateAjax()


					
	public

getAjaxec(JsExpressionable|View|string|null $response, JsChain $chain = null): string

Provided with a $response from callbacks convert it into a JavaScript code.

Parameters

$response

response from callbacks,


					
	public

getUrl(string $mode = 'callback'): string

Return URL that will trigger action on this callback. If you intend to request the URL loading from inside JavaScript,…

Return URL that will trigger action on this callback. If you intend to request the URL loading from inside JavaScript, it's always advised to use getJsUrl instead.

Overrides

Atk4\Ui\Callback::getUrl()


					
	private

_getProperAction(View|string|JsExpressionable $response): JsExpressionable

Transform response into proper JS Action and return it.


					
	private

_jsRenderIntoModal(View $response): JsExpressionable

Methods inherited from Atk4\Ui\Callback
`add(), init(), setUrlTrigger(), getUrlTrigger(), terminateJson(), isTriggered(), getTriggeredValue(), canTerminate(), canTrigger(), getJsUrl(),`

Methods inherited from Atk4\Ui\AbstractView
`getOwner()`

Methods used from Atk4\Core\AppScopeTrait
`assertInstanceOfApp(), issetApp(), getApp(), setApp()`

Methods used from Atk4\Core\ContainerTrait
`_uniqueElementName(), _addContainer(), removeElement(), _shorten(), getElement(), hasElement()`

Methods used from Atk4\Core\InitializerTrait
`isInitialized(), assertIsInitialized(), invokeInit()`

Methods used from Atk4\Core\StaticAddToTrait
`_addToAdd(), addTo(), addToWithCl(), addToWithClUnsafe()`

Methods used from Atk4\Core\TrackableTrait
`issetOwner(), setOwner(), unsetOwner(), getDesiredName(), destroy()`

Constants inherited from Atk4\Ui\Callback
`URL_QUERY_TRIGGER_PREFIX, URL_QUERY_TARGET`

Properties
`public`	`array<string, string\|JsExpressionable>`	`$args = []` Holds information about arguments passed in to the callback. Holds information about arguments passed in to the callback.	#
`public`	`string`	`$confirm` Text to display as a confirmation. Set with setConfirm(..). Text to display as a confirmation. Set with setConfirm(..).	#
`public`	`array\|null`	`$apiConfig` Use this apiConfig variable to pass API settings to Fomantic-UI in .api(). Use this apiConfig variable to pass API settings to Fomantic-UI in .api().	#
`public`	`string\|null`	`$storeName` Include web storage data item (key) value to be included in the request. Include web storage data item (key) value to be included in the request.	#
`public`	`bool`	`$triggerOnReload = false`	#

Properties inherited from Atk4\Ui\Callback
`$urlTrigger,`

Properties inherited from Atk4\Ui\AbstractView
`$_addLater, $_rendered, $elements`

Properties used from Atk4\Core\AppScopeTrait
`$_app, $maxNameLength, $uniqueNameHashes`

Properties used from Atk4\Core\ContainerTrait
`$_elementNameCounts`

Properties used from Atk4\Core\InitializerTrait
`$_initialized`

Properties used from Atk4\Core\NameTrait
`$name`

Properties used from Atk4\Core\TrackableTrait
`$_owner, $shortName`

Namespaces

Classes

Traits

Exceptions

Class Atk4\Ui\JsCallback

Overriden by

Overrides

Overriden by

Parameters

Overriden by

Parameters

Overrides