View Source SmeeView.Aspects.Logo (SmeeView v0.2.1)
Represents and processes <mdui:Logo> elements in entity metadata as Aspect structs.
The functions in this module are intended to be applied to individual Aspect structs - for extracting and processing collections of these records please use the matching View module.
Summary
Functions
Is the URL a data:
URL containing the actual logo, rather than a normal HTTP address?
Returns the file format of the image, if known, based on the URL
Is this aspect relevant to the IdP role?
Returns the language of this aspect (as a two letter ISO 639-1 code)
Is the aspect using this language? (two letter ISO 639-1 code)
Returns the URL for this aspect as a parsed URI struct.
Returns the total number of pixels (X x Y)
Returns the associated role for this aspect: :sp, :idp or :all
Returns the shape of the logo (:square, :portrait or :landscape)
Returns the size of the logo as a word. These words are currently arbitrary, from an old application
Is this aspect relevant to the SP role?
Does the logo use a HTTPS URL?
Returns the URL for this aspect, as a text binary
Is this a valid URL? Returns true if the URL can be parsed.
Types
Functions
Is the URL a data:
URL containing the actual logo, rather than a normal HTTP address?
Logo.data?(aspect)
# => true
Returns the file format of the image, if known, based on the URL
Logo.format(aspect)
# => :png
Is this aspect relevant to the IdP role?
Will return true
if the aspect has been derived from an IdP role, or is applicable to all roles.
Logo.idp?(aspect)
# => true
Returns the language of this aspect (as a two letter ISO 639-1 code)
If no language code has been set for this aspect then the default language code will be returned.
Logo.lang(aspect)
# => "fr"
Is the aspect using this language? (two letter ISO 639-1 code)
Returns true if the provided code matches that of the aspect.
If no language code has been set for this aspect then the aspect will be assumed to have the default language code.
Logo.lang?(aspect, "en")
# => false
Returns the URL for this aspect as a parsed URI struct.
If the URI cannot be parsed then an exception will be raised. If you need more control you should either
use valid?/1
first, or just use URI.parse/1
yourself.
Logo.parsed!(aspect)
# => %URI{...}
Returns the total number of pixels (X x Y)
Logo.pixels(aspect)
# => 4096
Returns the associated role for this aspect: :sp, :idp or :all
The role type is useful when handling a mixed list of aspects that may be specific to certain roles of an entity.
Logo.role(aspect)
# => :idp
Returns the shape of the logo (:square, :portrait or :landscape)
It's currently rather crude - only exact squares will return :square
Logo.shape(aspect)
# => :landscape
Returns the size of the logo as a word. These words are currently arbitrary, from an old application
Sizes are: :tiny, :small, :icon, :default, :medium, :large, :huge and :silly
Logo.size(aspect)
# => :large
Is this aspect relevant to the SP role?
Will return true
if the aspect has been derived from an SP role, or is applicable to all roles.
Logo.sp?(aspect)
# => false
Does the logo use a HTTPS URL?
Logo.tls?(aspect)
# => false
Returns the URL for this aspect, as a text binary
Aspects containing URLs are printable and can be converted to strings using Kernel.to_string/1
or
interpolated into another string.
Logo.url(aspect)
# => "https://idp.example.com/information"
Is this a valid URL? Returns true if the URL can be parsed.
Logo.valid?(aspect)
# => false