mediaCtrl
extends jController
in package
Table of Contents
Methods
- defaultIllustration() : jResponseBinary
- Get default illustration image for the Lizmap instance.
- getCssFile() : jResponseBinary|jResponseText
- Get a CSS file stored in the repository in a "media/themes" folder.
- getDefaultTheme() : jResponseZip
- Get default Lizmap theme as a ZIP file.
- getMedia() : jResponseBinary|jResponseJson
- Get a media file (image, html, csv, pdf, etc.) store in the repository.
- illustration() : jResponseBinary
- Get illustration image for a specified project.
- themeImage() : jResponseBinary|jResponseJson
- Get logo or background image defined in lizmap admin theme configuration.
- canBeCached() : bool
- Check if cache can be used because it is impossible to use cache on other request type that GET or HEAD.
- defaultIllustrationEtag() : mixed
- defaultIllustrationPath() : mixed
- error() : mixed
- Returns error.
- error401() : mixed
- Return 401.
- error403() : mixed
- Return 403.
- error404() : mixed
- Return 404.
- setEtagCacheHeaders() : jResponse
Methods
defaultIllustration()
Get default illustration image for the Lizmap instance.
public
defaultIllustration() : jResponseBinary
Return values
jResponseBinary —object The image for this project
getCssFile()
Get a CSS file stored in the repository in a "media/themes" folder.
public
getCssFile() : jResponseBinary|jResponseText
Url to images are replaced by getMedia URL.
Return values
jResponseBinary|jResponseText —object The transformed CSS file
getDefaultTheme()
Get default Lizmap theme as a ZIP file.
public
getDefaultTheme() : jResponseZip
Return values
jResponseZip —file containing the default theme
getMedia()
Get a media file (image, html, csv, pdf, etc.) store in the repository.
public
getMedia() : jResponseBinary|jResponseJson
Used to display media in the popup, via the information icon, etc.
Return values
jResponseBinary|jResponseJson —object The media
illustration()
Get illustration image for a specified project.
public
illustration() : jResponseBinary
Return values
jResponseBinary —object The image for this project
themeImage()
Get logo or background image defined in lizmap admin theme configuration.
public
themeImage() : jResponseBinary|jResponseJson
Return values
jResponseBinary|jResponseJson —configured theme logo
canBeCached()
Check if cache can be used because it is impossible to use cache on other request type that GET or HEAD.
protected
canBeCached() : bool
Return values
booldefaultIllustrationEtag()
protected
defaultIllustrationEtag() : mixed
defaultIllustrationPath()
protected
defaultIllustrationPath() : mixed
error()
Returns error.
protected
error(jResponseRedirect $message) : mixed
Parameters
- $message : jResponseRedirect
error401()
Return 401.
protected
error401(jResponseJson $message) : mixed
Parameters
- $message : jResponseJson
error403()
Return 403.
protected
error403(jResponseJson $message) : mixed
Parameters
- $message : jResponseJson
error404()
Return 404.
protected
error404(jResponseJson $message) : mixed
Parameters
- $message : jResponseJson
setEtagCacheHeaders()
protected
setEtagCacheHeaders(jResponse $resp, string $etag) : jResponse
Parameters
- $resp : jResponse
- $etag : string
Return values
jResponse —the response updated