Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe SimplePie_Enclosure

Fonctions membres publiques

 __construct ($link=null, $type=null, $length=null, $javascript=null, $bitrate=null, $captions=null, $categories=null, $channels=null, $copyright=null, $credits=null, $description=null, $duration=null, $expression=null, $framerate=null, $hashes=null, $height=null, $keywords=null, $lang=null, $medium=null, $player=null, $ratings=null, $restrictions=null, $samplingrate=null, $thumbnails=null, $title=null, $width=null)
 
 __toString ()
 
 get_bitrate ()
 
 get_caption ($key=0)
 
 get_captions ()
 
 get_category ($key=0)
 
 get_categories ()
 
 get_channels ()
 
 get_copyright ()
 
 get_credit ($key=0)
 
 get_credits ()
 
 get_description ()
 
 get_duration ($convert=false)
 
 get_expression ()
 
 get_extension ()
 
 get_framerate ()
 
 get_handler ()
 
 get_hash ($key=0)
 
 get_hashes ()
 
 get_height ()
 
 get_language ()
 
 get_keyword ($key=0)
 
 get_keywords ()
 
 get_length ()
 
 get_link ()
 
 get_medium ()
 
 get_player ()
 
 get_rating ($key=0)
 
 get_ratings ()
 
 get_restriction ($key=0)
 
 get_restrictions ()
 
 get_sampling_rate ()
 
 get_size ()
 
 get_thumbnail ($key=0)
 
 get_thumbnails ()
 
 get_title ()
 
 get_type ()
 
 get_width ()
 
 native_embed ($options='')
 
 embed ($options='', $native=false)
 
 get_real_type ($find_handler=false)
 

Champs de données

 $bitrate
 
 $captions
 
 $categories
 
 $channels
 
 $copyright
 
 $credits
 
 $description
 
 $duration
 
 $expression
 
 $framerate
 
 $handler
 
 $hashes
 
 $height
 
 $javascript
 
 $keywords
 
 $lang
 
 $length
 
 $link
 
 $medium
 
 $player
 
 $ratings
 
 $restrictions
 
 $samplingrate
 
 $thumbnails
 
 $title
 
 $type
 
 $width
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $link = null,
  $type = null,
  $length = null,
  $javascript = null,
  $bitrate = null,
  $captions = null,
  $categories = null,
  $channels = null,
  $copyright = null,
  $credits = null,
  $description = null,
  $duration = null,
  $expression = null,
  $framerate = null,
  $hashes = null,
  $height = null,
  $keywords = null,
  $lang = null,
  $medium = null,
  $player = null,
  $ratings = null,
  $restrictions = null,
  $samplingrate = null,
  $thumbnails = null,
  $title = null,
  $width = null 
)

Constructor, used to input the data

For documentation on all the parameters, see the corresponding properties and their accessors

idna_convert If available, this will convert an IDN

Références $bitrate, $captions, $categories, $channels, $copyright, $credits, $description, $duration, $expression, $framerate, $hashes, $height, $keywords, $lang, $length, $link, $medium, $player, $ratings, $restrictions, $samplingrate, $thumbnails, $title, $type, $width, SimplePie_Misc\compress_parse_url(), description, get_handler(), height, SimplePie_Misc\parse_url(), title, et width.

Documentation des fonctions membres

◆ __toString()

__toString ( )

String-ified version

Renvoie
string

◆ embed()

embed (   $options = '',
  $native = false 
)

Embed the enclosure using Javascript

$options is an array or comma-separated key:value string, with the following properties:

  • alt (string): Alternate content for when an end-user does not have the appropriate handler installed or when a file type is unsupported. Can be any text or HTML. Defaults to blank.
  • altclass (string): If a file type is unsupported, the end-user will see the alt text (above) linked directly to the content. That link will have this value as its class name. Defaults to blank.
  • audio (string): This is an image that should be used as a placeholder for audio files before they're loaded (QuickTime-only). Can be any relative or absolute URL. Defaults to blank.
  • bgcolor (string): The background color for the media, if not already transparent. Defaults to #ffffff.
  • height (integer): The height of the embedded media. Accepts any numeric pixel value (such as 360) or auto. Defaults to auto, and it is recommended that you use this default.
  • loop (boolean): Do you want the media to loop when its done? Defaults to false.
  • mediaplayer (string): The location of the included mediaplayer.swf file. This allows for the playback of Flash Video (.flv) files, and is the default handler for non-Odeo MP3's. Defaults to blank.
  • video (string): This is an image that should be used as a placeholder for video files before they're loaded (QuickTime-only). Can be any relative or absolute URL. Defaults to blank.
  • width (integer): The width of the embedded media. Accepts any numeric pixel value (such as 480) or auto. Defaults to auto, and it is recommended that you use this default.
  • widescreen (boolean): Is the enclosure widescreen or standard? This applies only to video enclosures, and will automatically resize the content appropriately. Defaults to false, implying 4:3 mode.

Note: Non-widescreen (4:3) mode with width and height set to auto will default to 480x360 video resolution. Widescreen (16:9) mode with width and height set to auto will default to 480x270 video resolution.

Paramètres
array | string$optionsComma-separated key:value list, or array
bool$nativeUse <embed>
Renvoie
string HTML string to output

Références $alt, $handler, $height, $loop, $mime, $option, $options, $type, $width, elseif, get_extension(), get_handler(), get_link(), et get_real_type().

Référencé par native_embed().

◆ get_bitrate()

get_bitrate ( )

Get the bitrate

Renvoie
string|null

Références $bitrate, et null.

◆ get_caption()

get_caption (   $key = 0)

Get a single caption

Paramètres
int$key
Renvoie
SimplePie_Caption|null

Références $captions, $key, get_captions(), et null.

◆ get_captions()

get_captions ( )

Get all captions

Renvoie
array|null Array of {
Voir également
SimplePie_Caption} objects

Références $captions, et null.

Référencé par get_caption().

◆ get_categories()

get_categories ( )

Get all categories

Renvoie
array|null Array of {
Voir également
SimplePie_Category} objects

Références $categories, et null.

Référencé par get_category().

◆ get_category()

get_category (   $key = 0)

Get a single category

Paramètres
int$key
Renvoie
SimplePie_Category|null

Références $categories, $key, get_categories(), et null.

◆ get_channels()

get_channels ( )

Get the number of audio channels

Renvoie
int|null

Références $channels, et null.

◆ get_copyright()

get_copyright ( )

Get the copyright information

Renvoie
SimplePie_Copyright|null

Références $copyright, et null.

◆ get_credit()

get_credit (   $key = 0)

Get a single credit

Paramètres
int$key
Renvoie
SimplePie_Credit|null

Références $credits, $key, get_credits(), et null.

◆ get_credits()

get_credits ( )

Get all credits

Renvoie
array|null Array of {
Voir également
SimplePie_Credit} objects

Références $credits, et null.

Référencé par get_credit().

◆ get_description()

get_description ( )

Get the description of the enclosure

Renvoie
string|null

Références $description, description, et null.

◆ get_duration()

get_duration (   $convert = false)

Get the duration of the enclosure

Paramètres
string$convertConvert seconds into hh:mm:ss
Renvoie
string|int|null 'hh:mm:ss' string if $convert was specified, otherwise integer (or null if none found)

Références $duration, null, et SimplePie_Misc\time_hms().

◆ get_expression()

get_expression ( )

Get the expression

Renvoie
string Probably one of 'sample', 'full', 'nonstop', 'clip'. Defaults to 'full'

Références $expression, et null.

◆ get_extension()

get_extension ( )

Get the file extension

Renvoie
string|null

Références $url, null, et SimplePie_Misc\parse_url().

Référencé par embed(), et get_real_type().

◆ get_framerate()

get_framerate ( )

Get the framerate (in frames-per-second)

Renvoie
string|null

Références $framerate, et null.

◆ get_handler()

get_handler ( )

Get the preferred handler

Renvoie
string|null One of 'flash', 'fmedia', 'quicktime', 'wmedia', 'mp3'

Références get_real_type().

Référencé par __construct(), et embed().

◆ get_hash()

get_hash (   $key = 0)

◆ get_hashes()

get_hashes ( )

Get all credits

Renvoie
array|null Array of strings, see {
Voir également
get_hash()}

Références $hashes, et null.

Référencé par get_hash().

◆ get_height()

get_height ( )

Get the height

Renvoie
string|null

Références $height, height, et null.

◆ get_keyword()

get_keyword (   $key = 0)

Get a single keyword

Paramètres
int$key
Renvoie
string|null

Références $key, $keywords, get_keywords(), et null.

◆ get_keywords()

get_keywords ( )

Get all keywords

Renvoie
array|null Array of strings

Références $keywords, et null.

Référencé par get_keyword().

◆ get_language()

get_language ( )

Get the language

string|null Language code as per RFC 3066

Références $lang, et null.

◆ get_length()

get_length ( )

Get length

Renvoie
float Length in bytes

Références $length, et null.

Référencé par get_size().

◆ get_link()

get_link ( )

Get the URL

Renvoie
string|null

Références null.

Référencé par embed().

◆ get_medium()

◆ get_player()

get_player ( )

Get the player URL

Typically the same as {

Voir également
get_permalink()}
Renvoie
string|null Player URL

Références $player, et null.

◆ get_rating()

get_rating (   $key = 0)

Get a single rating

Paramètres
int$key
Renvoie
SimplePie_Rating|null

Références $key, $ratings, get_ratings(), et null.

◆ get_ratings()

get_ratings ( )

Get all ratings

Renvoie
array|null Array of {
Voir également
SimplePie_Rating} objects

Références $ratings, et null.

Référencé par get_rating().

◆ get_real_type()

get_real_type (   $find_handler = false)

Get the real media type

Often, feeds lie to us, necessitating a bit of deeper inspection. This converts types to their canonical representations based on the file extension

Voir également
get_type()
Paramètres
bool$find_handlerInternal use only, use {
Voir également
get_handler()} instead
Renvoie
string MIME type

Références $type, elseif, get_extension(), get_type(), et null.

Référencé par embed(), et get_handler().

◆ get_restriction()

get_restriction (   $key = 0)

Get a single restriction

Paramètres
int$key
Renvoie
SimplePie_Restriction|null

Références $key, $restrictions, get_restrictions(), et null.

◆ get_restrictions()

get_restrictions ( )

Get all restrictions

Renvoie
array|null Array of {
Voir également
SimplePie_Restriction} objects

Références $restrictions, et null.

Référencé par get_restriction().

◆ get_sampling_rate()

get_sampling_rate ( )

Get the sampling rate (in kHz)

Renvoie
string|null

Références $samplingrate, et null.

◆ get_size()

get_size ( )

Get the file size (in MiB)

Renvoie
float|null File size in mebibytes (1048 bytes)

Références $length, get_length(), et null.

◆ get_thumbnail()

get_thumbnail (   $key = 0)

Get a single thumbnail

Paramètres
int$key
Renvoie
string|null Thumbnail URL

Références $key, $thumbnails, get_thumbnails(), et null.

◆ get_thumbnails()

get_thumbnails ( )

Get all thumbnails

Renvoie
array|null Array of thumbnail URLs

Références $thumbnails, et null.

Référencé par get_thumbnail().

◆ get_title()

get_title ( )

Get the title

Renvoie
string|null

Références $title, null, et title.

◆ get_type()

get_type ( )

Get mimetype of the enclosure

Voir également
get_real_type()
Renvoie
string|null MIME type

Références $type, et null.

Référencé par get_real_type().

◆ get_width()

get_width ( )

Get the width

Renvoie
string|null

Références $width, null, et width.

◆ native_embed()

native_embed (   $options = '')

Embed the enclosure using <embed>

Obsolète:
Use the second parameter to {
Voir également
embed} instead
Paramètres
array | string$optionsSee first paramter to {
Voir également
embed}
Renvoie
string HTML string to output

Références $options, et embed().

Documentation des champs

◆ $bitrate

$bitrate

Référencé par __construct(), et get_bitrate().

◆ $captions

$captions

Référencé par __construct(), get_caption(), et get_captions().

◆ $categories

$categories

◆ $channels

$channels

Référencé par __construct(), et get_channels().

◆ $copyright

$copyright

Référencé par __construct(), et get_copyright().

◆ $credits

$credits

Référencé par __construct(), get_credit(), et get_credits().

◆ $description

◆ $duration

$duration

Référencé par __construct(), et get_duration().

◆ $expression

$expression

Référencé par __construct(), et get_expression().

◆ $framerate

$framerate

Référencé par __construct(), et get_framerate().

◆ $handler

$handler

Référencé par embed().

◆ $hashes

$hashes

Référencé par __construct(), get_hash(), et get_hashes().

◆ $height

Référencé par __construct(), embed(), et get_height().

◆ $javascript

$javascript

◆ $keywords

$keywords

Référencé par __construct(), get_keyword(), et get_keywords().

◆ $lang

$lang

Référencé par __construct(), et get_language().

◆ $length

$length

Référencé par __construct(), get_length(), et get_size().

◆ $link

$link

Référencé par __construct().

◆ $medium

$medium

Référencé par __construct(), et get_medium().

◆ $player

$player

Référencé par __construct(), et get_player().

◆ $ratings

$ratings

Référencé par __construct(), get_rating(), et get_ratings().

◆ $restrictions

$restrictions

◆ $samplingrate

$samplingrate

Référencé par __construct(), et get_sampling_rate().

◆ $thumbnails

$thumbnails

◆ $title

Référencé par __construct(), et get_title().

◆ $type

$type

◆ $width

Référencé par __construct(), embed(), et get_width().


La documentation de cette classe a été générée à partir du fichier suivant :