Public Member Functions | Public Attributes

Plugin::Plugin Class Reference

Classe abstraite Plugin dont doit heriter chacun des plugins. More...

List of all members.

Public Member Functions

def __init__
 Constructeur.
def vider
 Efface les informations mémorisées.
def listerOptions
 Effectue le listage des options.
def rafraichir
 Rafraichie les informations durable du plugins comme la liste des émissions.
def listerChaines
 Effectue le listage des chaînes.
def listerEmissions
 Effectue le listage des émissions.
def listerFichiers
 Effectue le listage des fichiers.
def ajouterChaine
 Ajoute une chaine à celle disponible pour ce plugin.
def ajouterEmission
 Ajoute une émission à celle disponible pour ce plugin.
def ajouterFichier
 Ajoute un fichier à ceux disponible pour ce plugin.
def afficher
 Affiche le texte "text" dans la console avec en préfixe le nom du plugin.
def sauvegarderPreference
 Sauvegarde les options.
def chargerPreference
 Charge les préférences.
def sauvegarderCache
 Sauvegarde un objet dans le cache.
def chargerCache
 Charge le fichier de cache.
def getOption
 Renvoie la valeur d'une option.
def optionTexte
 Ajoute une option texte.
def optionBouleen
 Ajoute une option bouléen.
def optionChoixMultiple
 Ajoute une option liste (choix multiple).
def optionChoixUnique
 Ajoute une option liste (choix unique).

Public Attributes

 API
 Instance de l'API à utilisé pour l'accès au méthode de l'API.
 pluginDatas
 pluginOptions
 nom
 Nom du plugin.
 url
 Url du site internet du plugin.
 frequence
 Nombre de jour avant le rafraichissement automatique du plugin.
 fichierConfiguration
 Chemin du fichier de configuration.
 fichierCache
 Chemin du fichier de cache.

Detailed Description

Classe abstraite Plugin dont doit heriter chacun des plugins.

Les plugins doivent hériter de cette classe et redéfinir les méthodes listerChaines, listerEmissions et listerFichiers. La méthode listerOptions est optionnellement à redéfinir (dans le cas où il y aurai des options).


Member Function Documentation

def Plugin::Plugin::__init__ (   self,
  nom = None,
  url = None,
  frequence = 7 
)

Constructeur.

Parameters:
self le plugin courant
nom le nom du plugin
url l'url du site internet
frequence la fréquence (en jour) de rafraichissement, 0 pour ne jamais rafraichir
def Plugin::Plugin::afficher (   self,
  text,
  ligne = None 
)

Affiche le texte "text" dans la console avec en préfixe le nom du plugin.

Facilite le déboguage, utilisé cette méthode plutôt que "print".

Parameters:
self le plugin courant
text le texte à afficher en console
ligne paramètre inutile, conservé par rétrocompatibilité
Returns:
Rien
def Plugin::Plugin::ajouterChaine (   self,
  chaine 
)

Ajoute une chaine à celle disponible pour ce plugin.

A utiliser dans listerChaines et en remplacement d'un retour de paramètre.

Parameters:
self le plugin courant
chaine le nom de la chaine
Returns:
Rien
def Plugin::Plugin::ajouterEmission (   self,
  chaine,
  emission 
)

Ajoute une émission à celle disponible pour ce plugin.

A utiliser dans listerEmissions et en remplacement d'un retour de paramètre.

Parameters:
self le plugin courant
chaine le nom de la chaine de l'émission
emission le nom de l'émission
Returns:
Rien
def Plugin::Plugin::ajouterFichier (   self,
  emission,
  fichier 
)

Ajoute un fichier à ceux disponible pour ce plugin.

A utiliser dans listerFichiers et en remplacement d'un retour de paramètre.

Parameters:
self le plugin courant
emission l'emission du fichier
fichier le fichier
Returns:
Rien
def Plugin::Plugin::chargerCache (   self  ) 

Charge le fichier de cache.

Parameters:
self le plugin courant
Returns:
l'objet sauvegardé dans le cache ou None en cas d'échec
def Plugin::Plugin::chargerPreference (   self  ) 

Charge les préférences.

Charge les préférences du fichier de configuration, ne pas utiliser. Les options sont chargées automatiquement.

Parameters:
self le plugin courant
Returns:
Rien
Deprecated:
Ne fait plus rien. Ne pas uiliser.
def Plugin::Plugin::getOption (   self,
  nom 
)

Renvoie la valeur d'une option.

L'option doit être ajouter dans listerOptions pour que cela renvoie une valeur.

Parameters:
self le plugin courant
nom le nom de l'option
Returns:
la valeur de l'option, None en cas d'échec
def Plugin::Plugin::listerChaines (   self  ) 

Effectue le listage des chaînes.

Utiliser ajouterChaine pour ajouter une chaîne à la liste.

Parameters:
self le plugin courant
Returns:
rien
def Plugin::Plugin::listerEmissions (   self,
  chaine 
)

Effectue le listage des émissions.

Utiliser ajouterEmission pour ajouter une émission à la liste.

Parameters:
self le plugin courant
chaine la chaine
Returns:
rien
def Plugin::Plugin::listerFichiers (   self,
  emission 
)

Effectue le listage des fichiers.

Utiliser ajouterFichier pour ajouter un fichier à la liste.

Parameters:
self le plugin courant
emission l'emission
Returns:
Rien
def Plugin::Plugin::listerOptions (   self  ) 

Effectue le listage des options.

Utiliser optionTexte, optionCheckbox, optionListeMultiple et optionListeUnique pour ajouter des options

Parameters:
self le plugin courant
Returns:
rien
def Plugin::Plugin::optionBouleen (   self,
  nom,
  description,
  defaut 
)

Ajoute une option bouléen.

Parameters:
self le plugin courant
nom le nom de l'option (sert d'identifiant)
description la description de l'option
defaut la valeur par défaut, True pour coché, faut pour décoché
Returns:
rien
def Plugin::Plugin::optionChoixMultiple (   self,
  nom,
  description,
  defauts,
  valeurs 
)

Ajoute une option liste (choix multiple).

Parameters:
self le plugin courant
nom le nom de l'option (sert d'identifiant)
description la description de l'option
valeurs les valeurs possibles (liste)
defauts les valeurs sélectionnées (liste)
Returns:
rien
def Plugin::Plugin::optionChoixUnique (   self,
  nom,
  description,
  defaut,
  valeurs 
)

Ajoute une option liste (choix unique).

Parameters:
self le plugin courant
nom le nom de l'option (sert d'identifiant)
description la description de l'option
valeurs les valeurs possibles (liste)
defaut la valeur par défaut
Returns:
rien
def Plugin::Plugin::optionTexte (   self,
  nom,
  description,
  defaut 
)

Ajoute une option texte.

Parameters:
self le plugin courant
nom le nom de l'option (sert d'identifiant)
description la description de l'option
defaut la valeur par défaut (celle qui sera présente lors de l'affichage des options)
Returns:
rien
def Plugin::Plugin::rafraichir (   self  ) 

Rafraichie les informations durable du plugins comme la liste des émissions.

Y placer les traitements lourd n'ayant pas besoin d'être fait souvent.

Parameters:
self le plugin courant
Returns:
Rien
def Plugin::Plugin::sauvegarderCache (   self,
  objet 
)

Sauvegarde un objet dans le cache.

Attention, cette méthode écrase le cache déjà enregistré.

Parameters:
self le plugin courant
objet l'objet à sauvegarder
Returns:
Rien
def Plugin::Plugin::sauvegarderPreference (   self  ) 

Sauvegarde les options.

Sauvegarde les options dans le fichier de configuration, ne pas utiliser. Les options sont sauvegardées automatiquement.

Parameters:
self le plugin courant
Returns:
Rien
Deprecated:
Ne fait plus rien. Ne pas uiliser.
def Plugin::Plugin::vider (   self  ) 

Efface les informations mémorisées.

Parameters:
self l'objet courant

Member Data Documentation

Instance de l'API à utilisé pour l'accès au méthode de l'API.


The documentation for this class was generated from the following file:
 All Classes Functions Variables