Class Provider

Service Provider object

All provider classes should extend this class, and implement the appropriate contract interface.

Direct known subclasses

Namespace: Xoops\Core\Service
Package: Xoops\Core
Category: Xoops\Core\Service\Provider
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
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Service/Provider.php

Methods summary
`public`	# `__construct( Xoops\Core\Service\Manager $manager, string $service )` __construct __construct Parameters `$manager` Manager instance `$service` service name (case sensitive)
`public Xoops\Core\Service\Manager`	# `getProviderMode( )` getProviderMode getProviderMode Returns `Xoops\Core\Service\Manager` MODE constant
`public`	# `register( string $object )` registerProvider - register a provider of a named service registerProvider - register a provider of a named service Parameters `$object` instantiated object that provides the service
`public array &`	# `getRegistered( )` getRegistered - access list of registered providers getRegistered - access list of registered providers Returns array of registered providers managed by this instance
`public`	# `sortProviders( )` sortProviders - sort providers into priority order sortProviders - sort providers into priority order
`public boolean`	# `isAvailable( )` isAvailable - indicate the availability of an actual provider isAvailable - indicate the availability of an actual provider In many cases a null provider can be called without changing the flow of the calling program. In some cases, the availability of a provider may need to be reflected in the caller, i.e. adding a UI button or menu item. Returns boolean true if actual provider is available, otherwise false
`public Xoops\Core\Service\Response`	# `__call( string $name, mixed $arguments )` All contract specified methods go here All contract specified methods go here Parameters `$name` method to call `$arguments` any arguments Returns `Xoops\Core\Service\Response` Response
`public static null`	# `__callStatic( string $name, mixed $arguments )` All static methods go here and will return null All static methods go here and will return null Parameters `$name` not used `$arguments` not used Returns null

Magic methods summary
`public Xoops\Core\Service\Response`	# `getAvatarUrl( mixed $userinfo )` ; ; Parameters `$userinfo` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `getAvatarEditUrl( XoopsUser $userinfo )` ; ; Parameters `$userinfo` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `getImgUrl( string $value, mixed $p2 = null, mixed $d3 = null, mixed $d4 = null, mixed $d5 = null )` ; ; Parameters `$value` `$p2` `$d3` `$d4` `$d5` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `getImgTag( string $value, mixed $d2 = null, mixed $d3 = null, mixed $d4 = null, mixed $d5 = null )` ; ; Parameters `$value` `$d2` `$d3` `$d4` `$d5` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `startPdf( )` ; ; Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setPageOrientation( string $pageOrientation )` ; ; Parameters `$pageOrientation` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setPageSize( string $pageSize )` ; ; Parameters `$pageSize` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setBaseUnit( string $unit )` ; ; Parameters `$unit` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setMargins( float $leftMargin, float $topMargin, float $rightMargin, float $bottomMargin )` ; ; Parameters `$leftMargin` `$topMargin` `$rightMargin` `$bottomMargin` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setBaseFont( string $fontFamily, string $fontStyle, float\|null $fontSize )` ; ; Parameters `$fontFamily` `$fontStyle` `$fontSize` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setDefaultMonospacedFont( string $monoFontFamily )` ; ; Parameters `$monoFontFamily` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setAuthor( string $pdfAuthor )` ; ; Parameters `$pdfAuthor` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setTitle( string $pdfTitle )` ; ; Parameters `$pdfTitle` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setSubject( string $pdfSubject )` ; ; Parameters `$pdfSubject` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `setKeywords( array $pdfKeywords )` ; ; Parameters `$pdfKeywords` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `addHtml( string $html )` ; ; Parameters `$html` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `outputPdfInline( string $name )` ; ; Parameters `$name` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `outputPdfDownload( string $name )` ; ; Parameters `$name` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `fetchPdf( )` ; ; Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `getUserRank( mixed $userinfo )` ; ; Parameters `$userinfo` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `getAssignableUserRankList( )` ; ; Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `renderEmoji( string $buffer )` ; ; Parameters `$buffer` Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `getEmojiList( )` ; ; Returns `Xoops\Core\Service\Response`
`public Xoops\Core\Service\Response`	# `renderEmojiSelector( string $identifier )` ; ; Parameters `$identifier` Returns `Xoops\Core\Service\Response`

Properties summary
`protected`	`$manager`	# `null`
`protected`	`$service`	# `null`
`protected Xoops\Core\Service\AbstractContract[]`	`$providers` $providers $providers	# `array()`

Namespaces

Classes

Class Provider

Direct known subclasses

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns