Abstract Class humhub\modules\live\driver\BaseDriver

Inheritancehumhub\modules\live\driver\BaseDriver » yii\base\BaseObject
Subclasseshumhub\modules\live\driver\Poll, humhub\modules\live\driver\Push
Available since version1.2

Base driver for live event storage and distribution

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getJsConfig() Returns the JavaScript Configuration for this driver humhub\modules\live\driver\BaseDriver
onContentContainerLegitimationChanged() This callback will be executed whenever the access rules for a contentcontainer is changed. e.g. user joined a new space as member. humhub\modules\live\driver\BaseDriver
send() Sends a live event humhub\modules\live\driver\BaseDriver

Method Details

getJsConfig() public abstract method (available since version 1.3)

Returns the JavaScript Configuration for this driver

See also humhub\widgets\CoreJsConfig.

public abstract array getJsConfig ( )
return array

The JS Configuratoin

onContentContainerLegitimationChanged() public method (available since version 1.3)

This callback will be executed whenever the access rules for a contentcontainer is changed. e.g. user joined a new space as member.

See also humhub\modules\live\Module::getLegitimateContentContainerIds().

public void onContentContainerLegitimationChanged ( humhub\modules\user\models\User $user, $legitimation = [] )
$user
$legitimation
send() public abstract method

Sends a live event

public abstract boolean send ( humhub\modules\live\components\LiveEvent $liveEvent )
$liveEvent humhub\modules\live\components\LiveEvent

The live event to send

return boolean

Indicates the sent was successful