\Social\View\HelperSocialProvider

Class SocialProvider View helper used to render links for social media platform login and registration

Summary

Methods
Properties
Constants
__construct()
render()
renderSocialRegistration()
renderLogin()
setBaseUrl()
No public properties found
No constants found
translate()
getProviderList()
$moduleOptions
$substitutableUrl
N/A
No private methods found
No private properties found
N/A

Properties

$moduleOptions

$moduleOptions : \Social\Options\ModuleOptions

Class object that aggregates social configuration options

Type

\Social\Options\ModuleOptions

$substitutableUrl

$substitutableUrl : string

URL string in which the provider can be substituted for the now known provider

Type

string

Methods

render()

render(string  $type) : string

Render the provider list of images for login page

Parameters

string $type

Returns

string

renderSocialRegistration()

renderSocialRegistration() : string

Render the provider list of images for registration page

Returns

string

renderLogin()

renderLogin() : string

Render the provider list of images for login and/or registration page

Returns

string

setBaseUrl()

setBaseUrl(string  $url) : $this

Set the base URL that can later have the provider name substituted

Parameters

string $url

Returns

$this

translate()

translate(string  $message) : string

Translate message

Parameters

string $message

Returns

string

getProviderList()

getProviderList() : string

Get unordered list of HTTP anchor elements with image files

Returns

string