API Documentation
\
Helper

\AcidFacebook

Classe de partage sur le réseau social Facebook.com

Summary

Methods
Properties
Constants
__construct()
setAutoconf()
urlShare()
printWidget()
setURL()
setWidth()
setShowFaces()
setVerb()
setCountBox()
getPrintedURL()
getPrintedWidth()
getPrintedShowFaces()
getPrintedVerb()
isCountBox()
No public properties found
BUTTON_LIKE
No protected methods found
No protected properties found
N/A
printLike()
$widgetType
$url
$width
$showFaces
$verb
$countBox
$_autoconf
N/A

Constants

BUTTON_LIKE

BUTTON_LIKE

Properties

$widgetType

$widgetType : integer

Le type de widget à générer, correspond aux constantes de la classe.

Type

integer — Le type de widget.

$url

$url : string

URL utilisé pour le partage, utilisé pour les LIKE entre autres.

Type

string — L'URL cible de ce partage.

$width

$width : integer

Taille du widget, à vérifier si elle fonctionne pour tous les widgets.

Type

integer — La taille en PX du widget.

$showFaces

$showFaces : boolean

Active ou non l'affichage des visages des personnes qui ont utilisé ce widget.

Type

boolean — True : Affiche les visages, False : N'affiche pas les visages

$verb

$verb : string

Verbe à utiliser pour le widget de partage.

Type

string — Le verbe à afficher pour le widget.

$countBox

$countBox : boolean

Permet de changer la forme du widget en countBox, ne fonctionne que pour le like.

Type

boolean — True pour le mettre en countBox, False pour ne pas le mettre en countBox.

$_autoconf

$_autoconf : array

Tableau d'autoconfiguration, valeurs par défaut pour le widget

Type

array — Le tableau de conf

Methods

__construct()

__construct(integer  $type = \AcidFacebook::BUTTON_LIKE) : \AcidFacebook

Constructeur

Parameters

integer $type

Returns

\AcidFacebook

setAutoconf()

setAutoconf(array  $tabConf = array())

Permet de définir une autoconfiguration par défaut du widget LIKE de Facebook. Clés autorisées : 'url' => string : L'URL à aimer 'width' => int : La taille du widget en pixels 'showFaces' => bool : TRUE pour afficher les visages, FALSE pour ne pas les afficher 'verb' => 'like' | 'recommend' : Le verbe à afficher pour le bouton (s'adapte à la langue) 'countBox' => bool : TRUE pour afficher un compteur de Like, FALSE pour ne pas l'afficher

Parameters

array $tabConf

Le tableau de configuration

urlShare()

urlShare(string  $title = null, string  $url = null)

Retourne une URL de partage Facebook en fonction des paramètre

Parameters

string $title

Le titre du lien à partager
string $url

L'URL à partager

printWidget()

printWidget()

Retourne le code HTML templaté du widget à afficher.

setURL()

setURL(string  $string = "")

Attribue l'URL cible du partage à cet objet.

Parameters

string $string

L'url à partager.

setWidth()

setWidth(integer  $width = 450)

Attribue la taille du widget à cet objet.

Parameters

integer $width

La taille à appliquer.

setShowFaces()

setShowFaces(boolean  $bool = false)

Donne au widget le droit d'afficher les visages ou non.

Parameters

boolean $bool

True pour affiche les visages, False pour ne pas les afficher.

setVerb()

setVerb(string  $string = "like")

Attribue le verbe de partage à cet objet.

Parameters

string $string

Le verbe à utiliser.

setCountBox()

setCountBox(boolean  $bool = false) : \AcidFacebook

Définit si l'affichage countBox est activé ou non

Parameters

boolean $bool

Returns

\AcidFacebook

getPrintedURL()

getPrintedURL() : string

Retourne l'url après traitement

Returns

string

getPrintedWidth()

getPrintedWidth() : \number

Retourne la largeur du widget

Returns

\number

getPrintedShowFaces()

getPrintedShowFaces() : string

Retourne l'état de l'affichage des visages des personnes qui ont utilisé ce widget

Returns

string

getPrintedVerb()

getPrintedVerb() : string

Retourne le verbe de partage du widget

Returns

string

isCountBox()

isCountBox() : boolean

Retourne vrai si l'affichage countBox est actif

Returns

boolean

printLike()

printLike(string  $tplPath)

Retourne le code HTML templaté du widget LIKE.

Parameters

string $tplPath

chemin vers le template