Packages

c

uk.gov.hmrc.play.language

LanguageController

abstract class LanguageController extends AbstractController with I18nSupport

LanguageController that switches the language of the current web application.

This trait provides a means of switching the current language and redirecting the user back to their original location. It expects a fallbackURL to be defined when implemented. It also expects a languageMap to be defined, this provides a way of mapping strings to Lang objects.

Linear Supertypes
I18nSupport, I18NSupportLowPriorityImplicits, AbstractController, BaseController, BaseControllerHelpers, ControllerHelpers, RequestImplicits, Rendering, RequestExtractors, AcceptExtractors, ContentTypes, HeaderNames, play.api.http.Status, HttpProtocol, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LanguageController
  2. I18nSupport
  3. I18NSupportLowPriorityImplicits
  4. AbstractController
  5. BaseController
  6. BaseControllerHelpers
  7. ControllerHelpers
  8. RequestImplicits
  9. Rendering
  10. RequestExtractors
  11. AcceptExtractors
  12. ContentTypes
  13. HeaderNames
  14. Status
  15. HttpProtocol
  16. Results
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LanguageController(languageUtils: LanguageUtils, cc: ControllerComponents)

Type Members

  1. implicit class RequestWithMessagesApi extends AnyRef
    Definition Classes
    I18NSupportLowPriorityImplicits
  2. implicit class ResultWithMessagesApi extends AnyRef
    Definition Classes
    I18NSupportLowPriorityImplicits
  3. class Status extends Result
    Definition Classes
    Results

Abstract Value Members

  1. abstract def fallbackURL: String

    A URL to fallback to if there is no referrer found in the request header *

    A URL to fallback to if there is no referrer found in the request header *

    Attributes
    protected
  2. abstract def languageMap: Map[String, Lang]

    A map from a String to Lang object *

    A map from a String to Lang object *

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val ACCEPT: String
    Definition Classes
    HeaderNames
  5. val ACCEPTED: Int
    Definition Classes
    Status
  6. val ACCEPT_CHARSET: String
    Definition Classes
    HeaderNames
  7. val ACCEPT_ENCODING: String
    Definition Classes
    HeaderNames
  8. val ACCEPT_LANGUAGE: String
    Definition Classes
    HeaderNames
  9. val ACCEPT_RANGES: String
    Definition Classes
    HeaderNames
  10. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String
    Definition Classes
    HeaderNames
  11. val ACCESS_CONTROL_ALLOW_HEADERS: String
    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_ALLOW_METHODS: String
    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_ALLOW_ORIGIN: String
    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_EXPOSE_HEADERS: String
    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_MAX_AGE: String
    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_REQUEST_HEADERS: String
    Definition Classes
    HeaderNames
  17. val ACCESS_CONTROL_REQUEST_METHOD: String
    Definition Classes
    HeaderNames
  18. val AGE: String
    Definition Classes
    HeaderNames
  19. val ALLOW: String
    Definition Classes
    HeaderNames
  20. val AUTHORIZATION: String
    Definition Classes
    HeaderNames
  21. val Accepted: Status
    Definition Classes
    Results
  22. def Action: ActionBuilder[Request, AnyContent]
    Definition Classes
    BaseController
  23. val BAD_GATEWAY: Int
    Definition Classes
    Status
  24. val BAD_REQUEST: Int
    Definition Classes
    Status
  25. val BINARY: String
    Definition Classes
    ContentTypes
  26. val BadGateway: Status
    Definition Classes
    Results
  27. val BadRequest: Status
    Definition Classes
    Results
  28. val CACHE_CONTROL: String
    Definition Classes
    HeaderNames
  29. val CACHE_MANIFEST: String
    Definition Classes
    ContentTypes
  30. val CHUNKED: String
    Definition Classes
    HttpProtocol
  31. val CONFLICT: Int
    Definition Classes
    Status
  32. val CONNECTION: String
    Definition Classes
    HeaderNames
  33. val CONTENT_DISPOSITION: String
    Definition Classes
    HeaderNames
  34. val CONTENT_ENCODING: String
    Definition Classes
    HeaderNames
  35. val CONTENT_LANGUAGE: String
    Definition Classes
    HeaderNames
  36. val CONTENT_LENGTH: String
    Definition Classes
    HeaderNames
  37. val CONTENT_LOCATION: String
    Definition Classes
    HeaderNames
  38. val CONTENT_MD5: String
    Definition Classes
    HeaderNames
  39. val CONTENT_RANGE: String
    Definition Classes
    HeaderNames
  40. val CONTENT_SECURITY_POLICY: String
    Definition Classes
    HeaderNames
  41. val CONTENT_SECURITY_POLICY_REPORT_ONLY: String
    Definition Classes
    HeaderNames
  42. val CONTENT_TRANSFER_ENCODING: String
    Definition Classes
    HeaderNames
  43. val CONTENT_TYPE: String
    Definition Classes
    HeaderNames
  44. val CONTINUE: Int
    Definition Classes
    Status
  45. val COOKIE: String
    Definition Classes
    HeaderNames
  46. val CREATED: Int
    Definition Classes
    Status
  47. def CSS(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  48. val Conflict: Status
    Definition Classes
    Results
  49. val Continue: Result
    Definition Classes
    Results
  50. val Created: Status
    Definition Classes
    Results
  51. val DATE: String
    Definition Classes
    HeaderNames
  52. val ETAG: String
    Definition Classes
    HeaderNames
  53. def EVENT_STREAM(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  54. val EXPECT: String
    Definition Classes
    HeaderNames
  55. val EXPECTATION_FAILED: Int
    Definition Classes
    Status
  56. val EXPIRES: String
    Definition Classes
    HeaderNames
  57. val EntityTooLarge: Status
    Definition Classes
    Results
  58. val ExpectationFailed: Status
    Definition Classes
    Results
  59. val FAILED_DEPENDENCY: Int
    Definition Classes
    Status
  60. val FORBIDDEN: Int
    Definition Classes
    Status
  61. val FORM: String
    Definition Classes
    ContentTypes
  62. val FORWARDED: String
    Definition Classes
    HeaderNames
  63. val FOUND: Int
    Definition Classes
    Status
  64. val FROM: String
    Definition Classes
    HeaderNames
  65. val FailedDependency: Status
    Definition Classes
    Results
  66. val Forbidden: Status
    Definition Classes
    Results
  67. def Found(url: String): Result
    Definition Classes
    Results
  68. val GATEWAY_TIMEOUT: Int
    Definition Classes
    Status
  69. val GONE: Int
    Definition Classes
    Status
  70. val GatewayTimeout: Status
    Definition Classes
    Results
  71. val Gone: Status
    Definition Classes
    Results
  72. val HOST: String
    Definition Classes
    HeaderNames
  73. def HTML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  74. val HTTP_1_0: String
    Definition Classes
    HttpProtocol
  75. val HTTP_1_1: String
    Definition Classes
    HttpProtocol
  76. val HTTP_2_0: String
    Definition Classes
    HttpProtocol
  77. val HTTP_VERSION_NOT_SUPPORTED: Int
    Definition Classes
    Status
  78. val HttpVersionNotSupported: Status
    Definition Classes
    Results
  79. val IF_MATCH: String
    Definition Classes
    HeaderNames
  80. val IF_MODIFIED_SINCE: String
    Definition Classes
    HeaderNames
  81. val IF_NONE_MATCH: String
    Definition Classes
    HeaderNames
  82. val IF_RANGE: String
    Definition Classes
    HeaderNames
  83. val IF_UNMODIFIED_SINCE: String
    Definition Classes
    HeaderNames
  84. val IM_A_TEAPOT: Int
    Definition Classes
    Status
  85. val INSUFFICIENT_STORAGE: Int
    Definition Classes
    Status
  86. val INTERNAL_SERVER_ERROR: Int
    Definition Classes
    Status
  87. val ImATeapot: Status
    Definition Classes
    Results
  88. val InsufficientStorage: Status
    Definition Classes
    Results
  89. val InternalServerError: Status
    Definition Classes
    Results
  90. def JAVASCRIPT(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  91. val JSON: String
    Definition Classes
    ContentTypes
  92. val LAST_MODIFIED: String
    Definition Classes
    HeaderNames
  93. val LENGTH_REQUIRED: Int
    Definition Classes
    Status
  94. val LINK: String
    Definition Classes
    HeaderNames
  95. val LOCATION: String
    Definition Classes
    HeaderNames
  96. val LOCKED: Int
    Definition Classes
    Status
  97. val Locked: Status
    Definition Classes
    Results
  98. val MAX_FORWARDS: String
    Definition Classes
    HeaderNames
  99. val METHOD_NOT_ALLOWED: Int
    Definition Classes
    Status
  100. val MOVED_PERMANENTLY: Int
    Definition Classes
    Status
  101. val MULTIPLE_CHOICES: Int
    Definition Classes
    Status
  102. val MULTI_STATUS: Int
    Definition Classes
    Status
  103. val MethodNotAllowed: Status
    Definition Classes
    Results
  104. def MovedPermanently(url: String): Result
    Definition Classes
    Results
  105. val MultiStatus: Status
    Definition Classes
    Results
  106. val NETWORK_AUTHENTICATION_REQUIRED: Int
    Definition Classes
    Status
  107. val NON_AUTHORITATIVE_INFORMATION: Int
    Definition Classes
    Status
  108. val NOT_ACCEPTABLE: Int
    Definition Classes
    Status
  109. val NOT_FOUND: Int
    Definition Classes
    Status
  110. val NOT_IMPLEMENTED: Int
    Definition Classes
    Status
  111. val NOT_MODIFIED: Int
    Definition Classes
    Status
  112. val NO_CONTENT: Int
    Definition Classes
    Status
  113. val NetworkAuthenticationRequired: Status
    Definition Classes
    Results
  114. val NoContent: Result
    Definition Classes
    Results
  115. val NonAuthoritativeInformation: Status
    Definition Classes
    Results
  116. val NotAcceptable: Status
    Definition Classes
    Results
  117. val NotFound: Status
    Definition Classes
    Results
  118. val NotImplemented: Status
    Definition Classes
    Results
  119. val NotModified: Result
    Definition Classes
    Results
  120. val OK: Int
    Definition Classes
    Status
  121. val ORIGIN: String
    Definition Classes
    HeaderNames
  122. val Ok: Status
    Definition Classes
    Results
  123. val PARTIAL_CONTENT: Int
    Definition Classes
    Status
  124. val PAYMENT_REQUIRED: Int
    Definition Classes
    Status
  125. val PERMANENT_REDIRECT: Int
    Definition Classes
    Status
  126. val PRAGMA: String
    Definition Classes
    HeaderNames
  127. val PRECONDITION_FAILED: Int
    Definition Classes
    Status
  128. val PRECONDITION_REQUIRED: Int
    Definition Classes
    Status
  129. val PROXY_AUTHENTICATE: String
    Definition Classes
    HeaderNames
  130. val PROXY_AUTHENTICATION_REQUIRED: Int
    Definition Classes
    Status
  131. val PROXY_AUTHORIZATION: String
    Definition Classes
    HeaderNames
  132. val PartialContent: Status
    Definition Classes
    Results
  133. val PaymentRequired: Status
    Definition Classes
    Results
  134. def PermanentRedirect(url: String): Result
    Definition Classes
    Results
  135. val PreconditionFailed: Status
    Definition Classes
    Results
  136. val PreconditionRequired: Status
    Definition Classes
    Results
  137. val RANGE: String
    Definition Classes
    HeaderNames
  138. val REFERER: String
    Definition Classes
    HeaderNames
  139. val REFERRER_POLICY: String
    Definition Classes
    HeaderNames
  140. val REQUESTED_RANGE_NOT_SATISFIABLE: Int
    Definition Classes
    Status
  141. val REQUEST_ENTITY_TOO_LARGE: Int
    Definition Classes
    Status
  142. val REQUEST_HEADER_FIELDS_TOO_LARGE: Int
    Definition Classes
    Status
  143. val REQUEST_TIMEOUT: Int
    Definition Classes
    Status
  144. val REQUEST_URI_TOO_LONG: Int
    Definition Classes
    Status
  145. val RESET_CONTENT: Int
    Definition Classes
    Status
  146. val RETRY_AFTER: String
    Definition Classes
    HeaderNames
  147. def Redirect(call: Call, status: Int): Result
    Definition Classes
    Results
  148. def Redirect(call: Call): Result
    Definition Classes
    Results
  149. def Redirect(url: String, queryStringParams: Map[String, Seq[String]], status: Int): Result
    Definition Classes
    Results
  150. def Redirect(url: String, statusCode: Int): Result
    Definition Classes
    Results
  151. val RequestHeaderFieldsTooLarge: Status
    Definition Classes
    Results
  152. val RequestTimeout: Status
    Definition Classes
    Results
  153. val ResetContent: Result
    Definition Classes
    Results
  154. val SEE_OTHER: Int
    Definition Classes
    Status
  155. val SERVER: String
    Definition Classes
    HeaderNames
  156. val SERVICE_UNAVAILABLE: Int
    Definition Classes
    Status
  157. val SET_COOKIE: String
    Definition Classes
    HeaderNames
  158. val SET_COOKIE2: String
    Definition Classes
    HeaderNames
  159. val STRICT_TRANSPORT_SECURITY: String
    Definition Classes
    HeaderNames
  160. val SWITCHING_PROTOCOLS: Int
    Definition Classes
    Status
  161. def SeeOther(url: String): Result
    Definition Classes
    Results
  162. val ServiceUnavailable: Status
    Definition Classes
    Results
  163. def Status(code: Int): Status
    Definition Classes
    Results
  164. val SwitchingProtocols: Result
    Definition Classes
    Results
  165. val TE: String
    Definition Classes
    HeaderNames
  166. val TEMPORARY_REDIRECT: Int
    Definition Classes
    Status
  167. def TEXT(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  168. lazy val TODO: Action[AnyContent]
    Definition Classes
    ControllerHelpers
  169. val TOO_MANY_REQUESTS: Int
    Definition Classes
    Status
  170. val TRAILER: String
    Definition Classes
    HeaderNames
  171. val TRANSFER_ENCODING: String
    Definition Classes
    HeaderNames
  172. def TemporaryRedirect(url: String): Result
    Definition Classes
    Results
  173. val TooManyRequests: Status
    Definition Classes
    Results
  174. val UNAUTHORIZED: Int
    Definition Classes
    Status
  175. val UNPROCESSABLE_ENTITY: Int
    Definition Classes
    Status
  176. val UNSUPPORTED_MEDIA_TYPE: Int
    Definition Classes
    Status
  177. val UPGRADE: String
    Definition Classes
    HeaderNames
  178. val UPGRADE_REQUIRED: Int
    Definition Classes
    Status
  179. val USER_AGENT: String
    Definition Classes
    HeaderNames
  180. val USE_PROXY: Int
    Definition Classes
    Status
  181. val Unauthorized: Status
    Definition Classes
    Results
  182. val UnprocessableEntity: Status
    Definition Classes
    Results
  183. val UnsupportedMediaType: Status
    Definition Classes
    Results
  184. val UriTooLong: Status
    Definition Classes
    Results
  185. val VARY: String
    Definition Classes
    HeaderNames
  186. val VIA: String
    Definition Classes
    HeaderNames
  187. val WARNING: String
    Definition Classes
    HeaderNames
  188. val WWW_AUTHENTICATE: String
    Definition Classes
    HeaderNames
  189. def XHTML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  190. def XML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  191. val X_CONTENT_SECURITY_POLICY_NONCE_HEADER: String
    Definition Classes
    HeaderNames
  192. val X_CONTENT_TYPE_OPTIONS: String
    Definition Classes
    HeaderNames
  193. val X_FORWARDED_FOR: String
    Definition Classes
    HeaderNames
  194. val X_FORWARDED_HOST: String
    Definition Classes
    HeaderNames
  195. val X_FORWARDED_PORT: String
    Definition Classes
    HeaderNames
  196. val X_FORWARDED_PROTO: String
    Definition Classes
    HeaderNames
  197. val X_FRAME_OPTIONS: String
    Definition Classes
    HeaderNames
  198. val X_PERMITTED_CROSS_DOMAIN_POLICIES: String
    Definition Classes
    HeaderNames
  199. val X_REQUESTED_WITH: String
    Definition Classes
    HeaderNames
  200. val X_XSS_PROTECTION: String
    Definition Classes
    HeaderNames
  201. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  202. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  203. val controllerComponents: ControllerComponents
    Attributes
    protected
    Definition Classes
    AbstractController → BaseControllerHelpers
  204. def defaultExecutionContext: ExecutionContext
    Definition Classes
    BaseControllerHelpers
  205. implicit lazy val defaultFormBinding: FormBinding
    Definition Classes
    BaseControllerHelpers
  206. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  207. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  208. implicit def fileMimeTypes: FileMimeTypes
    Definition Classes
    BaseControllerHelpers
  209. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  210. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  211. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  212. implicit def messagesApi: MessagesApi
    Definition Classes
    BaseControllerHelpers
  213. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  214. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  215. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  216. def parse: PlayBodyParsers
    Definition Classes
    BaseControllerHelpers
  217. implicit def request2Messages(implicit request: RequestHeader): Messages
    Definition Classes
    I18nSupport
  218. implicit def request2flash(implicit request: RequestHeader): Flash
    Definition Classes
    RequestImplicits
  219. implicit def request2session(implicit request: RequestHeader): Session
    Definition Classes
    RequestImplicits
  220. implicit def supportedLangs: Langs
    Definition Classes
    BaseControllerHelpers
  221. def switchToLanguage(language: String): Action[AnyContent]

    A public interface to switch to a new language.

    A public interface to switch to a new language.

    The language must be defined within the language map else the current language will be used.

    This function expects a language string as a parameter and will use this to switch the current application language. This function expects a referrer value within the request header and will redirect the user back to that value. If it is not set then the redirect will be to the fallbackURL.

    The returned Redirect object will also contain a flashing parameter which can be detected by controllers in order to show different behaviour if wanted.

    language

    - The language string to switch to.

    returns

    Redirect to referrer or fallbackURL, with new language. Or fallbackURL with default lang.

  222. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  223. def toString(): String
    Definition Classes
    AnyRef → Any
  224. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  225. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  226. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  227. def withCharset(mimeType: String)(implicit codec: Codec): String
    Definition Classes
    ContentTypes

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from I18nSupport

Inherited from I18NSupportLowPriorityImplicits

Inherited from AbstractController

Inherited from BaseController

Inherited from BaseControllerHelpers

Inherited from ControllerHelpers

Inherited from RequestImplicits

Inherited from Rendering

Inherited from RequestExtractors

Inherited from AcceptExtractors

Inherited from ContentTypes

Inherited from HeaderNames

Inherited from play.api.http.Status

Inherited from HttpProtocol

Inherited from Results

Inherited from AnyRef

Inherited from Any

Ungrouped