QrcodeProvider Class Reference

Inheritance diagram for QrcodeProvider:

Public Member Functions
	getDescription ()
	getImgTag (Response $response, $qrText, $attributes=array())
	getImgUrl (Response $response, $qrText)
	getName ()
Public Member Functions inherited from Xoops\Core\Service\AbstractContract
	getDescription ()
	getMode ()
	getName ()
	getPriority ()
	setPriority ($priority)

Protected Attributes
	$renderScript = 'modules/qrcode/include/qrrender.php'
Protected Attributes inherited from Xoops\Core\Service\AbstractContract
	$priority = Manager::PRIORITY_MEDIUM

Private Member Functions
	getQRUrl ($qrText)

Additional Inherited Members
Public Attributes inherited from Xoops\Core\Service\Contract\QrcodeInterface
const	MODE = \Xoops\Core\Service\Manager::MODE_EXCLUSIVE

Detailed Description

Definition at line 28 of file QrcodeProvider.php.

Member Function Documentation

QrcodeProvider::getDescription

(

)

getDescription - get human readable description of the service provider

Returns

string

Definition at line 49 of file QrcodeProvider.php.

QrcodeProvider::getImgTag	(	Response	$response,
			$qrText,
			$attributes = array()
	)

getImgTag - get a full HTML img tag to display a QR Code image of supplied text

Parameters

Response	$response	object
string	$qrText	text to encode in QR Code
array	$attributes	array of attribute name => value pairs for img tag

Returns

void - response->value set to image tag

Implements Xoops\Core\Service\Contract\QrcodeInterface.

Definition at line 94 of file QrcodeProvider.php.

References $url, getQRUrl(), and Xoops\Core\Service\Response\setValue().

Here is the call graph for this function:

QrcodeProvider::getImgUrl	(	Response	$response,
			$qrText
	)

getImgUrl - get URL to QR Code image of supplied text

Parameters

Response	$response	object
string	$qrText	text to encode in QR Code

Returns

void - response->value set to URL string

Implements Xoops\Core\Service\Contract\QrcodeInterface.

Definition at line 80 of file QrcodeProvider.php.

References getQRUrl(), and Xoops\Core\Service\Response\setValue().

Here is the call graph for this function:

QrcodeProvider::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.

Returns

string - a unique name for the service provider

Definition at line 39 of file QrcodeProvider.php.

QrcodeProvider::getQRUrl (   $qrText )

private

getQRUrl

Parameters

string

$qrText

text for QR code

Returns

string URL to obtain QR Code image of $qrText

Definition at line 62 of file QrcodeProvider.php.

References $url, $xoops, and Xoops\getInstance().

Referenced by getImgTag(), and getImgUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

QrcodeProvider::$renderScript = 'modules/qrcode/include/qrrender.php'

protected

Definition at line 31 of file QrcodeProvider.php.

---

The documentation for this class was generated from the following file:

• C:/usr64/htdocs/modules/qrcode/class/QrcodeProvider.php