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 NullProvider

Null Service Provider object

This provider will be used whenever there is no provider defined for the service name requested. This will allow service consumers to avoid handling the condition of a service not being available.

Any calls to service methods will return NULL.

Any read of service properties will return null, and any check for isset() will return false.

Xoops\Core\Service\Provider
Extended by Xoops\Core\Service\NullProvider
Namespace: Xoops\Core\Service
Package: Xoops\Core
Category: Xoops\Core\Service\NullProvider
Copyright: 2013-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/NullProvider.php
Methods summary
public
# __construct( Xoops\Core\Service\Manager $manager, string $service )

__construct

__construct

Parameters

$manager
Manager instance
$service
service name (case sensitive)

Overrides

Xoops\Core\Service\Provider::__construct()
public boolean
# isAvailable( )

isAvailable - indicate the (lack of) availability of an actual provider

isAvailable - indicate the (lack of) availability of an actual provider

Returns

boolean
false to indicate no provider is available

Overrides

Xoops\Core\Service\Provider::isAvailable()
public
# __set( string $name, mixed $value )

Any property writes will go here

Any property writes will go here

Parameters

$name
not used
$value
not used
public null
# __get( string $name )

Any property reads will go here and return null

Any property reads will go here and return null

Parameters

$name
not used

Returns

null
public false
# __isset( string $name )

Any isset() or empty() on a property will go here and return false

Any isset() or empty() on a property will go here and return false

Parameters

$name
not used

Returns

false
public
# __unset( string $name )

Any property unset() will go here

Any property unset() will go here

Parameters

$name
not used
public Xoops\Core\Service\Response
# __call( string $name, mixed $arguments )

All non-static methods go here and will return null response

All non-static methods go here and will return null response

Parameters

$name
not used
$arguments
not used

Returns

Xoops\Core\Service\Response
Response

Overrides

Xoops\Core\Service\Provider::__call()
public static Xoops\Core\Service\Response
# __callStatic( string $name, mixed $arguments )

All static methods go here and will return null response

All static methods go here and will return null response

Parameters

$name
not used
$arguments
not used

Returns

Xoops\Core\Service\Response
Response

Overrides

Xoops\Core\Service\Provider::__callStatic()
Methods inherited from Xoops\Core\Service\Provider
getProviderMode(), getRegistered(), register(), sortProviders()
Magic methods inherited from Xoops\Core\Service\Provider
addHtml(), fetchPdf(), getAssignableUserRankList(), getAvatarEditUrl(), getAvatarUrl(), getEmojiList(), getImgTag(), getImgUrl(), getUserRank(), outputPdfDownload(), outputPdfInline(), renderEmoji(), renderEmojiSelector(), setAuthor(), setBaseFont(), setBaseUnit(), setDefaultMonospacedFont(), setKeywords(), setMargins(), setPageOrientation(), setPageSize(), setSubject(), setTitle(), startPdf()
Properties inherited from Xoops\Core\Service\Provider
$manager, $providers, $service
API documentation generated by ApiGen