Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Interfaces

  • AvatarInterface
  • CountryflagInterface
  • EmojiInterface
  • HtmlToPdfInterface
  • QrcodeInterface
  • ThumbnailInterface
  • UserRankInterface
  • Overview
  • Namespace
  • Class
  • Tree

Interface UserRankInterface

UserRank service interface

Direct known implementers

UserRankProvider
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
Since: 2.6.0
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Service/Contract/UserRankInterface.php
Methods summary
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
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
Constants summary
string MODE
# Xoops\Core\Service\Contract\Manager::MODE_EXCLUSIVE
API documentation generated by ApiGen