Manual:Parser functions/es

Las funciones de analizador, añadida en MediaWiki 1.7, es un tipo de extension que integra estrechamente con el analizador. The phrase "parser function" should not be confused with, which is a collection of simple parser functions. (See for those.)

Descripción
Mientras que una extensión de marcado está concebida para tomar texto sin procesar y devolver HTML al navegador, una función de análisis puede «interactuar» con otros elementos wiki de la página. Por ejemplo, la salida de una función de análisis se podría usar como parámetro de una plantilla o en la construcción de un enlace.

La sintaxis típica de una función de análisis es:

Para más información, consulta de. Según esta documentación,


 * The callback function should have the form:
 * O con :
 * O con :

The first variant of the call passes all arguments as plain text. The second passes all arguments as an array of s, except for the first, which is currently text, though this may change in the future. These represent the unexpanded wikitext. The  parameter can be used to expand these arguments as needed. This is commonly used for conditional processing so that only the "true" case is evaluated with an if- or switch-like parser function. The frame object can also climb up the document tree to get information about the caller and has functions to determine and manage call depth, time-to-live, and whether the result of the parser function is volatile.

Crear una función de análisis es ligeramente más complejo que crear una nueva etiqueta porque el nombre de la función debe ser una palabra mágica, una palabra clave que sea compatible con el uso de alias y localización.



Ejemplo simple
A continuación hay un ejemplo de una extensión que crea una función de análisis.

El registro va a extension.json; el código, a includes/ExampleExtension.php:

Otro archivo, ExampleExtension.i18n.php, deberá contener:

Con esta extensión activada,



produce:


 * param1 is hello and param2 is hi and param3 is hey

Within LocalSettings.php
Magic words and their handling parser functions can be defined entirely in.



Funciones más largas
For longer functions, you may want to split the hook functions out to a _body.php or .hooks.php file and make them static functions of a class. Then you can load the class with and call the static functions in the hooks; e.g.:

Agrega esto en tu archivo :
 * See: writing an event handler for other styles.

Luego agrega esto en tu archivo :

Caching
Al igual que con extensiones de marcado, se puede usar para deshabilitar la caché para extensiones dinámicas.

Esto tiene un impacto significativamente negativo en el rendimiento, por lo tanto solo úsalo cuando sea necesario.



Interfaz del analizador


Control del análisis sintáctico de la salida
Para que el wikitexto devuelto por tu función de análisis esté completamente analizado (incluyendo las expansiones de plantillas), define la opción  como falsa en la salida.

Parece ser que el valor predeterminado para  cambió de falso a verdadero, al menos en algunos casos, en algún momento en torno a la versión 1.12.

En cambio, para que tu función de análisis devuelva HTML no analizado, en lugar de wikitexto, usa lo siguiente:

Nombramiento
Por defecto, MW añade una almohadilla («#») al nombre de cada función de análisis. Para suprimir este añadido (y obtener una función de análisis sin el prefijo «#»), debes incluir la constante SFH_NO_HASH en el argumento opcional de banderas en setFunctionHook, como se describe más adelante. To suppress that addition (and obtain a parser function with no "#" prefix), include the SFH_NO_HASH constant in the optional flags argument to setFunctionHook, as described below.

Al elegir un nombre sin almohadilla prefijada, ten en cuenta que ya no es posible transcluir una página con un nombre que empiece por ese nombre de función seguido del carácter dos puntos. En particular, evita nombres de función iguales al nombre de un espacio de nombres. En caso de que la transclusión interwiki esté habilitada, también debes evitar los nombres de función iguales a un prefijo interwiki.

The setFunctionHook hook
Para más información sobre la interfaz del analizador, consulta la documentación de setFunctionHook en includes/Parser.php. Aquí se muestra una copia (posiblemente obsoleta) de estos comentarios:

function setFunctionHook( $id, $callback, $flags = 0 ) Parámetros:


 * string $id - el identificador de la palabra mágica
 * mixed $callback - The callback function (and object) to use
 * integer $flags - Optional, set it to the SFH_NO_HASH constant to call the function without "#".

Return value: The old callback function for this name, if any

Create a function, e.g.,. The callback function should have the form:

The callback may either return the text result of the function, or an array with the text in element 0, and a number of flags in the other elements. The names of the flags are specified in the keys. Valid flags are:


 * forceRawInterwiki
 * Force interwiki transclusion to be done in raw mode, not rendered.


 * found
 * El texto devuelto es válido, deja de procesar la plantilla. Esto está activado por defecto.


 * isChildObj
 * The text is a DOM node needing expansion in a child frame.


 * isHTML
 * El valor devuelto está en HTML, protégelo contra transformaciones a wikitexto But see discussion


 * isLocalObj
 * The text is a DOM node needing expansion in the current frame.


 * noparse
 * Las etiquetas HTML inseguras no se deben suprimir, etc.


 * nowiki
 * El marcado wiki en el valor de retorno debe escaparse


 * preprocessFlags
 * Use these flags when parsing the returned text. This only applies when noparse is.


 * text
 * The text returned from the function. If isChildObj or isLocalObj are specified, this should be a DOM node instead.


 * title
 * The Title object where the text came from.

Expensive parser functions
Some parser functions represent a significant use of a wiki's resources and should be marked as "expensive". The number of expensive parser functions on any given page is limited by the setting. What counts as expensive is left up to the function itself, but typically, anything that is likely to cause a delay that extends beyond simple processing of data should be considered. This includes things like database reads and writes, launching a shell script synchronously, or file manipulation. On the other hand, not all such functions should necessarily be tagged. Semantic MediaWiki, for example, only marks a percentage of its database reads as expensive. This is due to the fact that on certain data-intensive pages, it could easily overflow the normal expensive parser function limits. In cases like this, the potential for noticeably slower performance that doesn't get flagged as expensive is a trade-off to having the functionality that SMW offers.

To mark your parser function as expensive, from within the body of the function's code, use. The return value will be if the expensive function limit has been reached or exceeded.



Parámetros nombrados
Las funciones de análisis no permiten el uso de parámetros nombrados de la manera en que lo hacen las plantillas y extensiones de marcado, pero a veces puede ser útil imitarlos. Los usuarios a menudo están acostumbrados a usar barras verticales ( | ) para separar argumentos, así que está bien poder hacerlo también en el contexto de las funciones de análisis. He aquí un ejemplo sencillo de cómo conseguirlo:



Véase también

 * La extensión ParserFunctions es una conocida colección de funciones de análisis.
 * - an (incomplete) list of parser functions provided by core and extensions
 * La extensión ParserFunctions es una conocida colección de funciones de análisis.
 * - an (incomplete) list of parser functions provided by core and extensions
 * La extensión ParserFunctions es una conocida colección de funciones de análisis.
 * - an (incomplete) list of parser functions provided by core and extensions
 * La extensión ParserFunctions es una conocida colección de funciones de análisis.
 * - an (incomplete) list of parser functions provided by core and extensions
 * - an (incomplete) list of parser functions provided by core and extensions
 * The Parser Hooks PHP library, which provides an object orientated interface for declarative parser hooks