Interface humhub\components\rendering\Viewable

Implemented byhumhub\components\SocialActivity, humhub\modules\activity\components\BaseActivity, humhub\modules\admin\notifications\ExcludeGroupNotification, humhub\modules\admin\notifications\IncludeGroupNotification, humhub\modules\admin\notifications\NewVersionAvailable, humhub\modules\comment\activities\NewComment, humhub\modules\comment\notifications\NewComment, humhub\modules\content\activities\ContentCreated, humhub\modules\content\notifications\ContentCreated, humhub\modules\friendship\notifications\Request, humhub\modules\friendship\notifications\RequestApproved, humhub\modules\friendship\notifications\RequestDeclined, humhub\modules\like\activities\Liked, humhub\modules\like\notifications\NewLike, humhub\modules\notification\components\BaseNotification, humhub\modules\space\activities\Created, humhub\modules\space\activities\MemberAdded, humhub\modules\space\activities\MemberRemoved, humhub\modules\space\activities\SpaceArchived, humhub\modules\space\activities\SpaceUnArchived, humhub\modules\space\notifications\ApprovalRequest, humhub\modules\space\notifications\ApprovalRequestAccepted, humhub\modules\space\notifications\ApprovalRequestDeclined, humhub\modules\space\notifications\ChangedRolesMembership, humhub\modules\space\notifications\Invite, humhub\modules\space\notifications\InviteAccepted, humhub\modules\space\notifications\InviteDeclined, humhub\modules\space\notifications\InviteRevoked, humhub\modules\space\notifications\UserAddedNotification, humhub\modules\user\activities\UserFollow, humhub\modules\user\notifications\Followed, humhub\modules\user\notifications\Mentioned

The Viewable interface is used for Classes that can be rendered by Renderer components.

A Renderer can make use of the html, json or text represenation when rendering a viewable.

Method Details

getViewName() public abstract method

public abstract string getViewName ( )
return string

Viewname of this viewable

getViewParams() public abstract method

Returns an array of view parameter, required for rendering.

public abstract void getViewParams ( $params = [] )
$params array
html() public abstract method

public abstract string html ( )
return string

Html content representation of this viewable.

json() public abstract method

public abstract string json ( )
return string

Json content representation of this viewable.

text() public abstract method

public abstract string text ( )
return string

Text content representation of this viewable.