Class UserRankProvider

UserRank provider for service manager

UserRankProvider implements Xoops\Core\Service\Contract\UserRankInterface

Package: UserRankProvider
Category: class
Copyright: 2013-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
Since: 2.6.0
Link: http://xoops.org
Located at odules/userrank/class/UserRankProvider.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`	# `getUserRank( Xoops\Core\Service\Response $response, mixed $userinfo )` getUserRank - given user info return array of rank information for the user getUserRank - given user info return array of rank information for the user Parameters `$response` \Xoops\Core\Service\Response object `$userinfo` Xoops\Core\Kernel\Handlers\XoopsUser object for user (preferred) or array of user info, 'uid' => (int) id of system user 'posts' => (int) contribution count associated with the user 'rank' => (int) id of manually assigned rank, 0 if none assigned Returns $response->value set to array of rank information 'title' => string that describes the rank 'image' => url of image associated with the rank Implementation of `Xoops\Core\Service\Contract\UserRankInterface::getUserRank()`
`public`	# `getAssignableUserRankList( Xoops\Core\Service\Response $response )` getAssignableUserRankList - return a list of ranks that can be assigned getAssignableUserRankList - return a list of ranks that can be assigned Parameters `$response` \Xoops\Core\Service\Response object Returns response->value set to array of (int) id => (string) rank title entries of assignable ranks Implementation of `Xoops\Core\Service\Contract\UserRankInterface::getAssignableUserRankList()`

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

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

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

Namespaces

Classes

Interfaces

Functions

Class UserRankProvider

Returns

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of