SimplePie_Enclosure Klassenreferenz

Öffentliche Methoden | Datenfelder
SimplePie_Enclosure Klassenreferenz

Öffentliche Methoden

 __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)
 

Datenfelder

 $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
 

Ausführliche Beschreibung

Definiert in Zeile 55 der Datei Enclosure.php.

Beschreibung der Konstruktoren und Destruktoren

__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

Definiert in Zeile 227 der Datei Enclosure.php.

Benutzt $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(), get_handler() und SimplePie_Misc\parse_url().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Elementfunktionen

__toString ( )

String-ified version

Rückgabe
string

Definiert in Zeile 269 der Datei Enclosure.php.

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.

Noch zu erledigen:
If the dimensions for media:content are defined, use them when width/height are set to 'auto'.
Parameter
array | string$optionsComma-separated key:value list, or array
bool$nativeUse <embed>
Rückgabe
string HTML string to output

Definiert in Zeile 970 der Datei Enclosure.php.

Benutzt $handler, $height, $type, $width, get_extension(), get_handler(), get_link() und get_real_type().

Wird benutzt von native_embed().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_bitrate ( )

Get the bitrate

Rückgabe
string|null

Definiert in Zeile 280 der Datei Enclosure.php.

Benutzt $bitrate.

get_caption (   $key = 0)

Get a single caption

Parameter
int$key
Rückgabe
SimplePie_Caption|null

Definiert in Zeile 298 der Datei Enclosure.php.

Benutzt $captions und get_captions().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_captions ( )

Get all captions

Rückgabe
array|null Array of {
Siehe auch
SimplePie_Caption} objects

Definiert in Zeile 316 der Datei Enclosure.php.

Benutzt $captions.

Wird benutzt von get_caption().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_categories ( )

Get all categories

Rückgabe
array|null Array of {
Siehe auch
SimplePie_Category} objects

Definiert in Zeile 352 der Datei Enclosure.php.

Benutzt $categories.

Wird benutzt von get_category().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_category (   $key = 0)

Get a single category

Parameter
int$key
Rückgabe
SimplePie_Category|null

Definiert in Zeile 334 der Datei Enclosure.php.

Benutzt $categories und get_categories().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_channels ( )

Get the number of audio channels

Rückgabe
int|null

Definiert in Zeile 369 der Datei Enclosure.php.

Benutzt $channels.

get_copyright ( )

Get the copyright information

Rückgabe
SimplePie_Copyright|null

Definiert in Zeile 386 der Datei Enclosure.php.

Benutzt $copyright.

get_credit (   $key = 0)

Get a single credit

Parameter
int$key
Rückgabe
SimplePie_Credit|null

Definiert in Zeile 404 der Datei Enclosure.php.

Benutzt $credits und get_credits().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_credits ( )

Get all credits

Rückgabe
array|null Array of {
Siehe auch
SimplePie_Credit} objects

Definiert in Zeile 422 der Datei Enclosure.php.

Benutzt $credits.

Wird benutzt von get_credit().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_description ( )

Get the description of the enclosure

Rückgabe
string|null

Definiert in Zeile 439 der Datei Enclosure.php.

Benutzt $description.

get_duration (   $convert = false)

Get the duration of the enclosure

Parameter
string$convertConvert seconds into hh:mm:ss
Rückgabe
string|int|null 'hh:mm:ss' string if $convert was specified, otherwise integer (or null if none found)

Definiert in Zeile 457 der Datei Enclosure.php.

Benutzt $duration und SimplePie_Misc\time_hms().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_expression ( )

Get the expression

Rückgabe
string Probably one of 'sample', 'full', 'nonstop', 'clip'. Defaults to 'full'

Definiert in Zeile 482 der Datei Enclosure.php.

Benutzt $expression.

get_extension ( )

Get the file extension

Rückgabe
string|null

Definiert in Zeile 499 der Datei Enclosure.php.

Benutzt SimplePie_Misc\parse_url().

Wird benutzt von embed() und get_real_type().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_framerate ( )

Get the framerate (in frames-per-second)

Rückgabe
string|null

Definiert in Zeile 517 der Datei Enclosure.php.

Benutzt $framerate.

get_handler ( )

Get the preferred handler

Rückgabe
string|null One of 'flash', 'fmedia', 'quicktime', 'wmedia', 'mp3'

Definiert in Zeile 534 der Datei Enclosure.php.

Benutzt get_real_type().

Wird benutzt von __construct() und embed().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_hash (   $key = 0)

Get a single hash

int $key string|null Hash as per media:hash, prefixed with "$algo:"

Definiert in Zeile 546 der Datei Enclosure.php.

Benutzt $hashes und get_hashes().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_hashes ( )

Get all credits

Rückgabe
array|null Array of strings, see {
Siehe auch
get_hash()}

Definiert in Zeile 564 der Datei Enclosure.php.

Benutzt $hashes.

Wird benutzt von get_hash().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_height ( )

Get the height

Rückgabe
string|null

Definiert in Zeile 581 der Datei Enclosure.php.

Benutzt $height.

get_keyword (   $key = 0)

Get a single keyword

Parameter
int$key
Rückgabe
string|null

Definiert in Zeile 617 der Datei Enclosure.php.

Benutzt $keywords und get_keywords().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_keywords ( )

Get all keywords

Rückgabe
array|null Array of strings

Definiert in Zeile 635 der Datei Enclosure.php.

Benutzt $keywords.

Wird benutzt von get_keyword().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_language ( )

Get the language

string|null Language code as per RFC 3066

Definiert in Zeile 599 der Datei Enclosure.php.

Benutzt $lang.

get_length ( )

Get length

Rückgabe
float Length in bytes

Definiert in Zeile 652 der Datei Enclosure.php.

Benutzt $length.

Wird benutzt von get_size().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_link ( )

Get the URL

Rückgabe
string|null

Definiert in Zeile 669 der Datei Enclosure.php.

Wird benutzt von embed().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_medium ( )

Get the medium

string|null Should be one of 'image', 'audio', 'video', 'document', 'executable'

Definiert in Zeile 687 der Datei Enclosure.php.

Benutzt $medium.

get_player ( )

Get the player URL

Typically the same as {

Siehe auch
get_permalink()}
Rückgabe
string|null Player URL

Definiert in Zeile 705 der Datei Enclosure.php.

Benutzt $player.

get_rating (   $key = 0)

Get a single rating

Parameter
int$key
Rückgabe
SimplePie_Rating|null

Definiert in Zeile 723 der Datei Enclosure.php.

Benutzt $ratings und get_ratings().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_ratings ( )

Get all ratings

Rückgabe
array|null Array of {
Siehe auch
SimplePie_Rating} objects

Definiert in Zeile 741 der Datei Enclosure.php.

Benutzt $ratings.

Wird benutzt von get_rating().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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

Siehe auch
get_type()
Parameter
bool$find_handlerInternal use only, use {
Siehe auch
get_handler()} instead
Rückgabe
string MIME type

Definiert in Zeile 1205 der Datei Enclosure.php.

Benutzt $type, get_extension() und get_type().

Wird benutzt von embed() und get_handler().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_restriction (   $key = 0)

Get a single restriction

Parameter
int$key
Rückgabe
SimplePie_Restriction|null

Definiert in Zeile 759 der Datei Enclosure.php.

Benutzt $restrictions und get_restrictions().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_restrictions ( )

Get all restrictions

Rückgabe
array|null Array of {
Siehe auch
SimplePie_Restriction} objects

Definiert in Zeile 777 der Datei Enclosure.php.

Benutzt $restrictions.

Wird benutzt von get_restriction().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_sampling_rate ( )

Get the sampling rate (in kHz)

Rückgabe
string|null

Definiert in Zeile 794 der Datei Enclosure.php.

Benutzt $samplingrate.

get_size ( )

Get the file size (in MiB)

Rückgabe
float|null File size in mebibytes (1048 bytes)

Definiert in Zeile 811 der Datei Enclosure.php.

Benutzt $length und get_length().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_thumbnail (   $key = 0)

Get a single thumbnail

Parameter
int$key
Rückgabe
string|null Thumbnail URL

Definiert in Zeile 830 der Datei Enclosure.php.

Benutzt $thumbnails und get_thumbnails().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

get_thumbnails ( )

Get all thumbnails

Rückgabe
array|null Array of thumbnail URLs

Definiert in Zeile 848 der Datei Enclosure.php.

Benutzt $thumbnails.

Wird benutzt von get_thumbnail().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_title ( )

Get the title

Rückgabe
string|null

Definiert in Zeile 865 der Datei Enclosure.php.

Benutzt $title.

get_type ( )

Get mimetype of the enclosure

Siehe auch
get_real_type()
Rückgabe
string|null MIME type

Definiert in Zeile 883 der Datei Enclosure.php.

Benutzt $type.

Wird benutzt von get_real_type().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

get_width ( )

Get the width

Rückgabe
string|null

Definiert in Zeile 900 der Datei Enclosure.php.

Benutzt $width.

native_embed (   $options = '')

Embed the enclosure using <embed>

Veraltet:
Use the second parameter to {
Siehe auch
embed} instead
Parameter
array | string$optionsSee first paramter to {
Siehe auch
embed}
Rückgabe
string HTML string to output

Definiert in Zeile 920 der Datei Enclosure.php.

Benutzt embed().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Datenelemente

$bitrate

Definiert in Zeile 61 der Datei Enclosure.php.

Wird benutzt von __construct() und get_bitrate().

$captions

Definiert in Zeile 67 der Datei Enclosure.php.

Wird benutzt von __construct(), get_caption() und get_captions().

$categories

Definiert in Zeile 73 der Datei Enclosure.php.

Wird benutzt von __construct(), get_categories() und get_category().

$channels

Definiert in Zeile 79 der Datei Enclosure.php.

Wird benutzt von __construct() und get_channels().

$copyright

Definiert in Zeile 85 der Datei Enclosure.php.

Wird benutzt von __construct() und get_copyright().

$credits

Definiert in Zeile 91 der Datei Enclosure.php.

Wird benutzt von __construct(), get_credit() und get_credits().

$description

Definiert in Zeile 97 der Datei Enclosure.php.

Wird benutzt von __construct() und get_description().

$duration

Definiert in Zeile 103 der Datei Enclosure.php.

Wird benutzt von __construct() und get_duration().

$expression

Definiert in Zeile 109 der Datei Enclosure.php.

Wird benutzt von __construct() und get_expression().

$framerate

Definiert in Zeile 115 der Datei Enclosure.php.

Wird benutzt von __construct() und get_framerate().

$handler

Definiert in Zeile 121 der Datei Enclosure.php.

Wird benutzt von embed().

$hashes

Definiert in Zeile 127 der Datei Enclosure.php.

Wird benutzt von __construct(), get_hash() und get_hashes().

$height

Definiert in Zeile 133 der Datei Enclosure.php.

Wird benutzt von __construct(), embed() und get_height().

$javascript

Definiert in Zeile 139 der Datei Enclosure.php.

$keywords

Definiert in Zeile 145 der Datei Enclosure.php.

Wird benutzt von __construct(), get_keyword() und get_keywords().

$lang

Definiert in Zeile 151 der Datei Enclosure.php.

Wird benutzt von __construct() und get_language().

$length

Definiert in Zeile 157 der Datei Enclosure.php.

Wird benutzt von __construct(), get_length() und get_size().

$link

Definiert in Zeile 163 der Datei Enclosure.php.

Wird benutzt von __construct().

$medium

Definiert in Zeile 169 der Datei Enclosure.php.

Wird benutzt von __construct() und get_medium().

$player

Definiert in Zeile 175 der Datei Enclosure.php.

Wird benutzt von __construct() und get_player().

$ratings

Definiert in Zeile 181 der Datei Enclosure.php.

Wird benutzt von __construct(), get_rating() und get_ratings().

$restrictions

Definiert in Zeile 187 der Datei Enclosure.php.

Wird benutzt von __construct(), get_restriction() und get_restrictions().

$samplingrate

Definiert in Zeile 193 der Datei Enclosure.php.

Wird benutzt von __construct() und get_sampling_rate().

$thumbnails

Definiert in Zeile 199 der Datei Enclosure.php.

Wird benutzt von __construct(), get_thumbnail() und get_thumbnails().

$title

Definiert in Zeile 205 der Datei Enclosure.php.

Wird benutzt von __construct() und get_title().

$type

Definiert in Zeile 211 der Datei Enclosure.php.

Wird benutzt von __construct(), embed(), get_real_type() und get_type().

$width

Definiert in Zeile 217 der Datei Enclosure.php.

Wird benutzt von __construct(), embed() und get_width().

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:




Korrekturen, Hinweise und Ergänzungen

Bitte scheuen Sie sich nicht und melden Sie, was auf dieser Seite sachlich falsch oder irreführend ist, was ergänzt werden sollte, was fehlt usw. Dazu bitte oben aus dem Menü Seite den Eintrag Support Forum wählen. Es ist eine kostenlose Anmeldung erforderlich, um Anmerkungen zu posten. Unpassende Postings, Spam usw. werden kommentarlos entfernt.
Erzeugt am Son Aug 4 2013 10:43:02 für MyOOS [Die Shop-Lösung] von   doxygen 1.8.4