How can I pre-raw a Model attribute for the Twig template? (ie. "myModel.myAttr" without requiring the raw filter)

Question

I have a model that returns markup as part of a variable. To escape twig's encoding we have to include the raw filter, like so :

{{ entry.customField | raw }}

The encoded output of that field is never useful, so ideally we'd have a way to get the same result without that twig filter. ie :

{{ entry.customField }}

Looking at the various twig and template components I doubt this is possible, but is there any hidden ways to get this working?

This is all designed to remove that extra requirement from the usage, so wrapping unescape tags around it isn't want I'm looking for.

Answer 1

The easiest way i've found to do that is to use TemplateHelper::getRaw()

So in your "prepValue" function inside your fieldtype class do something like this

function prepValue($value) {
    //any other data manipulation stuff
    return TemplateHelper::getRaw($value);
}

More info on prepValue in the docs.

Answer 2

Here are two ways I know of that allow you to mark your content as safe before you hand it off to the template. I'm not sure they will fit your exact use case, but perhaps they are a place to start:

1) Twig_Markup

From a variable you can return a new instance of Twig_Markup to the template:

return new \Twig_Markup($yourReturnData, craft()->templates->getTwig()->getCharset());

2) is_safe

When creating a Twig filter, you can return that data to the template marking it as safe by passing 'is_safe' => array('html') as the third argument to the Twig_Filter_Method.

public function getFilters()
{
  return array(
    'yourtwigfilter' => new Twig_Filter_Method(
      $this, 
     'customFunction', 
     array(
       'is_safe' => array('html')
     )
  ));
}