Interface EmojiInterface

Emoji service interface

Direct known implementers

Namespace: Xoops\Core\Service\Contract
Package: Xoops\Core
Category: Xoops\Core\Service\Contract
Copyright: 2015 The XOOPS Project https://github.com/XOOPS/XoopsCore
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Version: Release: 1.0
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Service/Contract/EmojiInterface.php

Methods summary
`public`	# `renderEmoji( Xoops\Core\Service\Response $response, string $buffer )` renderEmoji - given a string of source text being built for display, perform any processing of Emoji references required to display the intended imagery. renderEmoji - given a string of source text being built for display, perform any processing of Emoji references required to display the intended imagery. Parameters `$response` \Xoops\Core\Service\Response object `$buffer` source text to be processed Returns $response->value set to processed buffer
`public`	# `getEmojiList( Xoops\Core\Service\Response $response )` getEmojiList - return a list of available emoji getEmojiList - return a list of available emoji Parameters `$response` \Xoops\Core\Service\Response object Returns $response->value set to array of emoji information 'name' => (string) code that represents the emoji, i.e. ":wink:" 'description' => (string) description 'rendered' => (string) valid HTML to display a rendering of the emoji
`public`	# `renderEmojiSelector( Xoops\Core\Service\Response $response, string $identifier )` renderEmojiSelector - provide emoji selector support for editing renderEmojiSelector - provide emoji selector support for editing This should return an HTML string that, when displayed, will provide a link to an emoji selector. Additionally, this should perform any additional tasks required to make the link function, such as adding script or stylesheet assets to the active theme. Parameters `$response` \Xoops\Core\Service\Response object `$identifier` element identifier to receive emoji from selector Returns $response->value (string) HTML code to launch the emoji selector, i.e. button

Constants summary
`string`	`MODE`	# `Xoops\Core\Service\Contract\Manager::MODE_EXCLUSIVE`

Namespaces

Interfaces

Interface EmojiInterface

Direct known implementers

Parameters

Returns

Parameters

Returns

Parameters

Returns