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

Classes

  • AbstractContract
  • Manager
  • NullProvider
  • Provider
  • Response
  • Overview
  • Namespace
  • Class
  • Tree

Class AbstractContract

Xoops services manager contract boilerplate

All service providers should extend this class, and implement the relevant contract interface

Direct known subclasses

AvatarsProvider, CountryFlagProvider, GravatarsProvider, HtmlToPdfProvider, QrcodeProvider, SmiliesProvider, ThumbsProvider, UserRankProvider
Abstract
Namespace: Xoops\Core\Service
Package: Xoops\Core
Category: Xoops\Core\Service\AbstractContract
Copyright: 2013-2014 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/AbstractContract.php
Methods summary
public
# setPriority( integer $priority )

setPriority - set the priority for this contract provider

setPriority - set the priority for this contract provider

Parameters

$priority
  • priority of this contract provider
public integer
# getPriority( )

getPriority - get the priority for this contract provider

getPriority - get the priority for this contract provider

Returns

integer
  • priority of this contract provider
public integer
# getMode( )

getMode - get the MODE for the contract. The MODE is set in the contract Interface, and permissible values defined in Manager

getMode - get the MODE for the contract. The MODE is set in the contract Interface, and permissible values defined in Manager

Returns

integer
  • a MODE constant indicating how multiple services are handled
abstract 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
abstract public string
# getDescription( )

getDescription - get human readable description of the service provider

getDescription - get human readable description of the service provider

Returns

string
Properties summary
protected integer $priority

$priority - lowest value is highest priority

$priority - lowest value is highest priority

# Xoops\Core\Service\Manager::PRIORITY_MEDIUM
API documentation generated by ApiGen