Class Atk4\Ui\JsSse

`extends`	`JsCallback`
`uses`	`HookTrait`

Atk4\Ui\AbstractView uses AppScopeTrait, ContainerTrait, InitializerTrait, NameTrait, StaticAddToTrait, TrackableTrait
- Atk4\Ui\Callback
  - Atk4\Ui\JsCallback
    - Atk4\Ui\JsSse uses HookTrait

Located at ui/src/JsSse.php

Methods


					
	protected

init(): void

Called when view becomes part of render tree. You can override it but avoid placing any "heavy processing" here.

Overrides

Atk4\Ui\Callback::init()


					
	public

jsExecute(): JsBlock

Overrides

Atk4\Ui\JsCallback::jsExecute()


					
	public

set($fx = null, $args = null)

Executes user-specified action when callback is triggered.

Overrides

Atk4\Ui\JsCallback::set()


					
	public

send(JsExpressionable $action, bool $success = true): void

Sending an SSE action.


					
	public

terminateAjax($ajaxec, $msg = null, bool $success = true): never

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

Overrides

Atk4\Ui\JsCallback::terminateAjax()


					
	public

sendEvent(string $id, string $data, string $eventName = null): void

Output a SSE Event.


					
	public

flush(): void

Send Data in buffer to client.


					
	private

output(string $content): void


					
	public

sendBlock(string $id, string $data, string $eventName = null): void


					
	private

wrapData(string $string): string

Create SSE data string.


					
	protected

initSse(): void

It will ignore user abort by default.

Methods inherited from Atk4\Ui\JsCallback
`setConfirm(), getAjaxec(), getUrl(),`

Methods inherited from Atk4\Ui\Callback
`add(), 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()`

Methods used from Atk4\Core\HookTrait
`_rebindHookFxToFakeInstance(), _unbindHookFxIfBoundToThis(), _rebindHooksIfCloned(), onHook(), onHookShort(), _makeHookDynamicFx(), onHookDynamic(), onHookDynamicShort(), hookHasCallbacks(), removeHook(), hook(), breakHook()`

Constants
`public`	`HOOK_ABORTED = self::class . '@connectionAborted'` Executed when user aborted, or disconnect browser, when using this SSE. Executed when user aborted, or disconnect browser, when using this SSE.	#

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

Properties
`public`	`bool`	`$browserSupport = false` Allows us to fall-back to standard functionality of JsCallback if browser does not support SSE. Allows us to fall-back to standard functionality of JsCallback if browser does not support SSE.	#
`public`	`bool`	`$showLoader = false` Show Loader when doing sse. Show Loader when doing sse.	#
`public`	`bool`	`$closeBeforeUnload = false` add window.beforeunload listener for closing js EventSource. Off by default. add window.beforeunload listener for closing js EventSource. Off by default.	#
`public`	`bool`	`$keepAlive = false` Keep execution alive or not if connection is close by user. False mean that execution will stop on user aborted. Keep execution alive or not if connection is close by user. False mean that execution will stop on user aborted.	#
`public`	`Closure\|null`	`$echoFunction` custom function for outputting (instead of echo) custom function for outputting (instead of echo)	#

Properties inherited from Atk4\Ui\JsCallback
`$args, $confirm, $apiConfig, $storeName, $triggerOnReload`

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`

Properties used from Atk4\Core\HookTrait
`$hooks, $_hookIndexCounter, $_hookOrigThis`

Namespaces

Classes

Traits

Exceptions

Class Atk4\Ui\JsSse

Overrides

Overrides

Overrides

Parameters

Overrides