[ Index ]
 

Code source de Plume CMS 1.2.2

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/manager/extinc/ -> WikiRenderer.lib.php (sommaire)

Bibliotheque d'objets permettant de tranformer un texte, contenant des signes de formatages simples de type wiki, en un autre format tel que XHTML 1.0/strict

Author: Laurent Jouanneau <jouanneau@netcourrier.com>
Copyright: 2003-2004 Laurent Jouanneau
Version: 2.0dev-php5
Poids: 725 lignes (21 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 1 fichier
 manager/extinc/WikiRenderer.conf.php

Définit 4 classes

WikiTag:: (9 méthodes):
  WikiTag()
  addContent()
  addSeparator()
  getBeginTag()
  getEndTag()
  getNumberSeparator()
  useSeparator()
  isDummy()
  getHtmlContent()

WikiInlineParser:: (5 méthodes):
  WikiInlineParser()
  parse()
  _parse()
  _doCheckWikiWord()
  getError()

WikiRendererBloc:: (11 méthodes):
  WikiRendererBloc()
  open()
  close()
  closeNow()
  detect()
  getRenderedLine()
  getType()
  setMatch()
  getMatch()
  _renderInlineTag()
  _checkAttributes()

WikiRenderer:: (8 méthodes):
  WikiRenderer()
  render()
  getConfig()
  getInlineParser()
  getErrors()
  getVersion()
  _closeBloc()
  _openBloc()

Définit 8 fonctions

  clone()

Classe: WikiTag  - X-Ref

Implémente les propriétés d'un tag inline wiki et
le fonctionnement pour la génération
du code html correspondant

WikiTag($name, $properties)   X-Ref
Pas de description

addContent($string, $escape=true)   X-Ref
Pas de description

addSeparator()   X-Ref
Pas de description

getBeginTag()   X-Ref
Pas de description

getEndTag()   X-Ref
Pas de description

getNumberSeparator()   X-Ref
Pas de description

useSeparator()   X-Ref
Pas de description

isDummy()   X-Ref
Pas de description

getHtmlContent()   X-Ref
Pas de description

Classe: WikiInlineParser  - X-Ref

Moteur permettant de transformer les tags wiki inline
d'une chaine en équivalent HTML

WikiInlineParser($inlinetags,$simpletags,$separator='|',$checkWikiWord=false,$funcCheckWikiWord=null,$escapeHtml=true)   X-Ref
constructeur

param: array $inlinetags liste des tags permis
param: string caractère séparateur des différents composants

parse($line)   X-Ref
fonction principale du parser.

param: string   $line avec des eventuels tag wiki
return: string   chaine $line avec les tags wiki transformé en HTML

_parse($tag, &$posstart)   X-Ref
coeur du parseur. Appelé récursivement


_doCheckWikiWord($string)   X-Ref
Pas de description

getError()   X-Ref
Pas de description

Classe: WikiRendererBloc  - X-Ref

classe de base pour la transformation des élements de type bloc

WikiRendererBloc($wr)   X-Ref
constructeur à surcharger pour définir les valeurs des différentes proprietés

param: WikiRender $wr l'objet moteur wiki

open()   X-Ref
renvoi une chaine correspondant à l'ouverture du bloc

return: string

close()   X-Ref
renvoi une chaine correspondant à la fermeture du bloc

return: string

closeNow()   X-Ref
indique si le bloc doit etre immédiatement fermé

return: string

detect($string)   X-Ref
test si la chaine correspond au debut ou au contenu d'un bloc

param: string $string
return: boolean true: appartient au bloc

getRenderedLine()   X-Ref
renvoi la ligne, traitée pour le bloc. A surcharger éventuellement.

return: string

getType()   X-Ref
renvoi le type du bloc en cours de traitement

return: string

setMatch($match)   X-Ref
définit la liste des élements trouvés par l'expression régulière regexp

return: array

getMatch()   X-Ref
renvoi la liste des élements trouvés par l'expression régulière regexp

return: array

_renderInlineTag($string)   X-Ref
traite le rendu des signes de type inline (qui se trouvent necessairement dans des blocs

param: string  $string une chaine contenant une ou plusieurs balises wiki
return: string  la chaine transformée en XHTML

_checkAttributes(&$string)   X-Ref
détection d'attributs de bloc (ex:  >°°attr1|attr2|attr3°° la citation )


Classe: WikiRenderer  - X-Ref

Moteur de rendu. Classe principale à instancier pour transformer un texte wiki en texte XHTML.
utilisation :
$ctr = new WikiRenderer();
$monTexteXHTML = $ctr->render($montexte);

WikiRenderer($config=null, $prefix='WRB_')   X-Ref
instancie les différents objets pour le rendu des elements inline et bloc.


render($texte)   X-Ref
Methode principale qui transforme les tags wiki en tag XHTML

param: string  $texte le texte à convertir
return: string  le texte converti en XHTML

getConfig()   X-Ref
renvoi l'objet de configuration

return: WikiRendererConfig

getInlineParser()   X-Ref
Retourne l'objet inlineParser (WikiInlineParser) utilisé dans le moteur

return: WikiInlineParser

getErrors()   X-Ref
renvoi la liste des erreurs detectées par le moteur

return: array

getVersion()   X-Ref
renvoi la version de wikirenderer

return: string   version

_closeBloc()   X-Ref
ferme un bloc


_openBloc()   X-Ref
ouvre un bloc et le referme eventuellement suivant sa nature

return: boolean  indique si le bloc reste ouvert ou pas

Fonctions
Fonctions qui ne font pas partie d'une Classe:

clone($object)   X-Ref
Pas de description



Généré le : Mon Nov 26 11:57:01 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics