Class SmiliesProvider

Smilies provider for service manager

SmiliesProvider implements Xoops\Core\Service\Contract\EmojiInterface

Package: Smilies
Category: SmiliesProvider
Copyright: 2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Link: http://xoops.org
Located at odules/smilies/class/SmiliesProvider.php

Methods summary
`public string`	# `getName( )` getName - get a short name for this service provider. This should be unique within the scope of the named service, so using module dirname is suggested. getName - get a short name for this service provider. This should be unique within the scope of the named service, so using module dirname is suggested. Returns string a unique name for the service provider
`public string`	# `getDescription( )` getDescription - get human readable description of the service provider getDescription - get human readable description of the service provider Returns string
`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 Implementation of `Xoops\Core\Service\Contract\EmojiInterface::renderEmoji()`
`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 Implementation of `Xoops\Core\Service\Contract\EmojiInterface::getEmojiList()`
`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 Implementation of `Xoops\Core\Service\Contract\EmojiInterface::renderEmojiSelector()`

Methods inherited from Xoops\Core\Service\AbstractContract
`getMode(), getPriority(), setPriority()`

Constants inherited from Xoops\Core\Service\Contract\EmojiInterface
`MODE`

Properties inherited from Xoops\Core\Service\AbstractContract
`$priority`

Namespaces

Classes

Interfaces

Functions

Class SmiliesProvider

Returns

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of