escape

Documentation

Overview

Package escape provides Twig-compatible escape functions.

Index

• func CSS(in string) string
• func HTML(in string) string
• func HTMLAttribute(in string) string
• func JS(in string) string
• func URLQueryParam(in string) string

Examples

• CSS
• HTML
• HTMLAttribute
• JS
• URLQueryParam

Functions

func CSS

func CSS(in string) string

CSS provides a Twig-compatible CSS escaper.

Example

package main

import (
	"fmt"

	"bitbucket.org/ticketshopdev/stick/twig/escape"
)

func main() {
	input := "some \" bad content"
	fmt.Printf("div:after { content: \"%s\"; }", escape.CSS(input))
}

Output:

div:after { content: "some\0020\0022\0020bad\0020content"; }

func HTML

func HTML(in string) string

HTML provides a Twig-compatible HTML escape function.

Example

package main

import (
	"fmt"

	"bitbucket.org/ticketshopdev/stick/twig/escape"
)

func main() {
	input := "Very <unsafe> \"string & stuff'"
	fmt.Print(escape.HTML(input))
}

Output:

Very <unsafe> "string & stuff'

func HTMLAttribute

func HTMLAttribute(in string) string

HTMLAttribute provides a Twig-compatible escaper for HTML attributes.

Example

package main

import (
	"fmt"

	"bitbucket.org/ticketshopdev/stick/twig/escape"
)

func main() {
	input := "a bad\">\battribute<נש"
	fmt.Printf("<a href=\"%s\">A link</a>", escape.HTMLAttribute(input))
}

Output:

<a href="a&#32;bad&quot;&gt;&#xFFFD;attribute&lt;&#1504;&#1513;">A link</a>

func JS

func JS(in string) string

JS provides a Twig-compatible javascript escaper.

Example

package main

import (
	"fmt"

	"bitbucket.org/ticketshopdev/stick/twig/escape"
)

func main() {
	input := "some \"' bad javascript"
	fmt.Printf("var test = \"%s\";", escape.JS(input))
}

Output:

var test = "some\u0020\u0022\u0027\u0020bad\u0020javascript";

func URLQueryParam

func URLQueryParam(in string) string

URLQueryParam provides Twig-compatible query string escaper.

Example

package main

import (
	"fmt"

	"bitbucket.org/ticketshopdev/stick/twig/escape"
)

func main() {
	input := "מיין מאמעם"
	fmt.Printf("?who=%s", escape.URLQueryParam(input))
}

Output:

?who=%D7%9E%D7%99%D7%99%D7%9F%20%D7%9E%D7%90%D7%9E%D7%A2%D7%9D