Filtros/modificadores de salida

¿Qué son los filtros?¶

Los filtros en Revolution te permiten manipular la forma en que se presentan o analizan los datos en una etiqueta. Te permiten modificar valores directamente desde tus plantillas.

Filtro de entrada¶

Filtro de entrada

Filtro de salida¶

En Revolution, el filtro de salida aplica una o más series de modificadores de salida; su sintaxis se ve así:

[[elemento:modificador=`valor`]]

También se pueden encadenar (ejecutados de izquierda a derecha):

[[elemento:modificador:otromodificador=`valor`:yotromodificador:yotromas=`valor2`]]

También puedes utilizarlos para modificar la salida de un Snippet; ten en cuenta que el modificador viene después del nombre del Snippet y antes del signo de interrogación, por ej.

[[miSnippet:modificador=`valor`? &miSnippetParam=`algo`]]

Si tienes un código más largo en una declaración :then=:else= y deseas hacerlo más legible colocándolo en varias líneas, debes hacerlo así:

[[+placeholder:is=`0`:then=`
 // code
`:else=`
 // code
`]]

Modificadores de salida¶

La siguiente tabla enumera algunos de los modificadores existentes y muestra ejemplos de su uso. Aunque los ejemplos siguientes son etiquetas de marcador de posición, los modificadores de salida se pueden usar con cualquier etiqueta de MODX. Asegúrate de que el marcador de posición utilizado esté recibiendo datos.

Modificadores de salida condicionales¶

Modificadores de salida de cadena¶

Caching¶

In general, any content in a placeholder that you think might change dynamically should be uncached. For example:

[[+placeholder:default=`A default value!`]]

This means that this could sometimes be empty, and sometimes not. Why would you ever want that cached? That would eliminate the point of the output modifier.

Sometimes, output modifiers can be used on a cached placeholder - but only if you're calling the Snippet that sets them cached as well. Otherwise, you're performing an illogical maneuver - trying to cache statically something that was never meant to be static.

In general, the rule is: If you set a placeholder in an uncached Snippet, the placeholder needs to be uncached as well if you expect the content of the placeholder to differ.

Using an Output Modifier with Tag Properties¶

If you have properties on the tag, you'll want to specify those after the modifier:

[[!getResources:default=`Sorry - nothing matched your search.`?
    &tplFirst=`blogTpl`
    &parents=`2,3,4,8`
    &tvFilters=`blog_tags==%[[!tag:htmlent]]%`
    &includeTVs=`1`
]]

Creating a Custom Output Modifier¶

Also, Snippets can be used as custom modifiers. Simply put the Snippet name instead of the modifier. Example with a snippet named 'makeExciting' that appends a variable amount of exclamation marks:

[[*pagetitle:makeExciting=`4`]]

This document variable call with an output modifier will pass these properties to the snippet:

Here is a sample implementation for our snippet makeExciting:

$defaultExcitementLevel = 1;
$result = $input;
if (isset($options)) {
    $numberOfExclamations = $options;
} else {
    $numberOfExclamations = $defaultExcitementLevel;
}
for ( $i = $numberOfExclamations; $i > 0; $i-- ) {
    $result = $result . '!';
}
return $result;

The return value of the call will be whatever the snippet returns. For our example, the result will be the value of the pagetitle document variable appended with four exclamation marks.

The original input value will be returned if the snippet returns an empty string.

Chaining (Multiple Output Filters)¶

A good example of chaining would be to format a date string to another format, like so:

[[+mydate:strtotime:date=`%Y-%m-%d`]]

Directly accessing the modx_user_attributes table in the database using output modifiers instead of a Snippet can be accomplished simply by utilizing the userinfo modifier. Select the appropriate column from the table and specify it as the property of the output modifier, like so:

User Internal Key: [[!+modx.user.id:userinfo=`internalKey`]]<br />
User name: [[!+modx.user.id:userinfo=`username`]]<br />
Full Name: [[!+modx.user.id:userinfo=`fullname`]]<br />
Role:  [[!+modx.user.id:userinfo=`role`]]<br />
E-mail: [[!+modx.user.id:userinfo=`email`]]<br />
Phone: [[!+modx.user.id:userinfo=`phone`]]<br />
Mobile Phone: [[!+modx.user.id:userinfo=`mobilephone`]]<br />
Fax: [[!+modx.user.id:userinfo=`fax`]]<br />
Date of birth: [[!+modx.user.id:userinfo=`dob`:date=`%Y-%m-%d`]]<br />
Gender: [[!+modx.user.id:userinfo=`gender`]]<br />
Country: [[+modx.user.id:userinfo=`country`]]<br />
State: [[+modx.user.id:userinfo=`state`]]<br />
Zip Code: [[+modx.user.id:userinfo=`zip`]]<br />
Photo: [[+modx.user.id:userinfo=`photo`]]<br />
Comment: [[+modx.user.id:userinfo=`comment`]]<br />
Password: [[+modx.user.id:userinfo=`password`]]<br />
Cache Password: [[+modx.user.id:userinfo=`cachepwd`]]<br />
Last Login: [[+modx.user.id:userinfo=`lastlogin`:date=`%Y-%m-%d`]]<br />
The Login:[[+modx.user.id:userinfo=`thislogin`:date=`%Y-%m-%d`]]<br />
Number of Logins: [[+modx.user.id:userinfo=`logincount`]]

[[!+modx.user.id]] defaults to the currently logged in user ID. You can of course replace that with [[*createdby]] or other resource field or placeholders that return a numeric ID representing a user.

Note that the user ID and username is already available by default in MODX, so you dont need to use the "userinfo" modifier:

[[!+modx.user.id]] - Prints the ID
[[!+modx.user.username]] - Prints the username

You will most likely want to call these uncached (see note about caching above) to prevent unexpected results.

See Also¶

• Properties and Property Sets
• Templates
• Template Variables
• Snippets