Bind a query string parameter.
Bind a query string parameter.
Parameter key
QueryString data
None if the parameter was not present in the query string data. Otherwise, returns Some of either
Right of the parameter value, or Left of an error message if the binding failed.
Unbind a query string parameter.
Unbind a query string parameter.
Parameter key
Parameter value.
a query string fragment containing the key and its value. E.g. "foo=42"
Javascript function to unbind in the Javascript router.
Binder for query string parameters.
You can provide an implementation of
QueryStringBindable[A]for any typeAyou want to be able to bind directly from the request query string.For example, if you have the following type to encode pagination:
Play will create a
Pager(5, 42)value from a query string looking like/foo?p.index=5&p.size=42if you define an instance ofQueryStringBindable[Pager]available in the implicit scope.For example:
object Pager { implicit def queryStringBinder(implicit intBinder: QueryStringBindable[Int]) = new QueryStringBindable[Pager] { override def bind(key: String, params: Map[String, Seq[String]]): Option[Either[String, Pager]] = { for { index <- intBinder.bind(key + ".index", params) size <- intBinder.bind(key + ".size", params) } yield { (index, size) match { case (Right(index), Right(size)) => Right(Pager(index, size)) case _ => Left("Unable to bind a Pager") } } } override def unbind(key: String, pager: Pager): String = { intBinder.unbind(key + ".index", pager.index) + "&" + intBinder.unbind(key + ".size", pager.size) } } }To use it in a route, just write a type annotation aside the parameter you want to bind: