BinaryInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: ==Name== BinaryInformation - Binärdaten ==Beschreibung== Ein BinaryInformation-Objekt reprästentiert Binären-Content. Dies sind im Regelfall Dateien wie PDF, DOC, ....)
 
 
(19 dazwischenliegende Versionen von 6 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==Beschreibung==
−
Ein BinaryInformation-Objekt reprästentiert Binären-Content. Dies sind im Regelfall Dateien wie PDF, DOC, .... Handelt es sich um Textdateien, werden diese auch als Binärdaten behandelt.
+
Ein BinaryInformation-Objekt repräsentiert binären Content. Dies sind im Regelfall Dateien wie PDF, DOC, .... Handelt es sich um Textdateien, werden diese auch als Binärdaten behandelt. Für einige Dateiformate gibt es spezialisierte Erweiterungen dieses Objekts.
 +
 
 +
;Folgende Dateiformate besitzen erweiterte BinaryInformation-Objekte:
 +
* [[ImageInformation]]
 +
* [[SwfInformation]]
  
 
==Attribute==
 
==Attribute==
−
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
 
|-
 
|-
−
| xxx
+
| id
 +
| [[ID]]
 +
| ID des Objektes
 +
| 1
 +
|-
 +
| field
 +
| [[String]]
 +
| Variablenname des Objektes
 +
| 1
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Daten
 +
| 2.13
 +
|-
 +
| root
 +
| [[Element]]
 +
| Root-Element dieser Information
 +
| 1
 +
|-
 +
| parent
 +
| [[ID]]
 +
| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 +
| 1
 +
|-
 +
| locale
 +
| [[Locale]]
 +
| Sprache, für die die Information gilt
 +
| 1
 +
|-
 +
| isEmpty
 +
| [[Boolean]]
 +
| <code>true</code>, wenn die Größe der Binäredaten 0 ist
 +
| 1
 +
|-
 +
| binary
 +
| [[ID]]
 +
| ID, unter der die Bilddaten selbst erreichbar sind
 +
| 1
 +
|-
 +
| binary.media
 +
| [[BinDBMedia]]
 +
| Medien-Objekt der [BinDB]
 +
| 2.22
 +
|-
 +
| binDBMedia
 +
| [[BinDBMedia]]
 +
| Entspricht <code>binary.media</code> wenn der Artikel noch nicht gepeichert ist (Edit-Moduls, Preview)
 +
| 2.22
 +
|-
 +
| filename
 +
| [[String]]
 +
| Dateiname des Bildes
 +
| 1
 +
|-
 +
| filesize
 
| [[Number]]
 
| [[Number]]
−
| xxx
+
| Dateigröße in Bytes
 
| 1
 
| 1
 
|-
 
|-
−
| xxx
+
| format
−
| [[Condition]]
+
| [[String]]
−
| xxx
+
| Binärformat (pdf, doc, ...)
 
| 1
 
| 1
 
|-
 
|-
−
| xxx
+
| mime
−
| [[Collection]]
+
| [[String]]
−
| xxx
+
| MIME-Typ (<code>application/pdf</code>, <code>application/msword</code>, ...)
 
| 1
 
| 1
 
|-
 
|-
−
| xxx
+
| isImage
−
| [[Element]]
+
| [[Boolean]]
−
| xxx
+
| Liefert immer <code>false</code>
 
| 1
 
| 1
 
|}
 
|}
  
 
==Methoden==
 
==Methoden==
−
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
! Methode || Rückgabewert || Beschreibung || ab IES Version
 
|-
 
|-
−
| <code>xxx</code>
+
| <code>reader([[String]] charsetName)</code>
−
| [[String]]
+
| Reader
−
| xxx.
+
| Liefert einen Reader auf die Binärdaten zurück. Dieser kann z.B. mit sp:print verwendet werden, um Text-Binäredaten (z.B. CSS) selbst im Template auszugeben. Default-Encoding ist UTF-8.
−
| 1
+
| 2.5.4
 +
|-
 +
| <code>stream()</code>
 +
| Reader
 +
| Liefert einen Stream auf die Binärdaten zurück. Dieser kann z.B. mit sp:print und encoding="base64" verwendet werden um Bilder direkt Inline in HTML auszugeben.
 +
| 2.5.5
 
|-
 
|-
−
| <code>xxx</code>
+
| <code>toXip([[Boolean]] emptyFields)</code>
−
| [[String]]
+
| String
−
| xxx.
+
| Erzeugt XML-Daten im XIP-Format für dieses Objekt
−
| 1
+
| 2.14
 
|}
 
|}
  
−
;<code>xxx</code>
+
;<code>[[String]] reader([[String]] charsetName)</code>
−
:xxx.
+
:Liefert einen Reader auf die Binärdaten zurück. (Beispiel: <sp:print name="!{css.upload}.media.binary.reader('utf-8')"/>)
 
:;Parameter
 
:;Parameter
−
::;<code>xxx</code>
+
::;<code>String charsetName</code> (Optional)
−
:::xxx.
+
:::Charset mit dem die Binärdaten interpretiert werden sollen. Dieser Parameter ist Optional. Wird dieser Parameter nicht angegeben, wird UTF-8 verwendet.
−
::;<code>xxx</code>
 
−
:::xxx.
 
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[String]]
+
::;Reader
−
:::xxx.
+
:::Reader der Text-Binärdaten.
 +
 
 +
;<code>Bytes stream()</code>
 +
:Liefert einen Stream auf die Binärdaten zurück. (Beispiel: <sp:print name="!{image.upload}.media.binary.stream()" encoding="base64"/>)
 +
;Rückgabewert
 +
:;Stream
 +
::Stream der Binärdaten.
 +
<noinclude>
  
−
;<code>xxx</code>
+
;<code>[[String]] toXip([[Boolean]] emptyFields)</code>
−
:xxx.
+
:Erzeugt XML-Daten im XIP-Format für dieses Objekt.
 
:;Parameter
 
:;Parameter
−
::;<code>xxx</code>
+
::;<code>Boolean emptyFields</code>
−
:::xxx.
+
:::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
−
::;<code>xxx</code>
 
−
:::xxx.
 
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[String]]
+
::;String
−
:::xxx.
+
:::XML-Daten im XIP-Format
  
−
<!--
 
−
bitte die passenden Kategorien auswählen und Kommentar entfernen
 
−
--------------------------------------------------------------
 
−
<noinclude>
 
 
[[Category:Objekte]]
 
[[Category:Objekte]]
−
[[Category:Qualität_des_Inhalts_prüfen]]
 
−
[[Category:Qualität_der_Sprache_prüfen]]
 
−
[[Category:Qualität_des_Codes_prüfen]]
 
 
</noinclude>
 
</noinclude>
−
-->
 

Aktuelle Version vom 12. Februar 2021, 07:01 Uhr

Name

BinaryInformation - Binärdaten

Beschreibung

Ein BinaryInformation-Objekt repräsentiert binären Content. Dies sind im Regelfall Dateien wie PDF, DOC, .... Handelt es sich um Textdateien, werden diese auch als Binärdaten behandelt. Für einige Dateiformate gibt es spezialisierte Erweiterungen dieses Objekts.

Folgende Dateiformate besitzen erweiterte BinaryInformation-Objekte

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Objektes 1
field String Variablenname des Objektes 1
lastField String Variablenname des Objektes ohne Struktur-Daten 2.13
root Element Root-Element dieser Information 1
parent ID ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein 1
locale Locale Sprache, für die die Information gilt 1
isEmpty Boolean true, wenn die Größe der Binäredaten 0 ist 1
binary ID ID, unter der die Bilddaten selbst erreichbar sind 1
binary.media BinDBMedia Medien-Objekt der [BinDB] 2.22
binDBMedia BinDBMedia Entspricht binary.media wenn der Artikel noch nicht gepeichert ist (Edit-Moduls, Preview) 2.22
filename String Dateiname des Bildes 1
filesize Number Dateigröße in Bytes 1
format String Binärformat (pdf, doc, ...) 1
mime String MIME-Typ (application/pdf, application/msword, ...) 1
isImage Boolean Liefert immer false 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
reader(String charsetName) Reader Liefert einen Reader auf die Binärdaten zurück. Dieser kann z.B. mit sp:print verwendet werden, um Text-Binäredaten (z.B. CSS) selbst im Template auszugeben. Default-Encoding ist UTF-8. 2.5.4
stream() Reader Liefert einen Stream auf die Binärdaten zurück. Dieser kann z.B. mit sp:print und encoding="base64" verwendet werden um Bilder direkt Inline in HTML auszugeben. 2.5.5
toXip(Boolean emptyFields) String Erzeugt XML-Daten im XIP-Format für dieses Objekt 2.14
String reader(String charsetName)
Liefert einen Reader auf die Binärdaten zurück. (Beispiel: <sp:print name="!{css.upload}.media.binary.reader('utf-8')"/>)
Parameter
String charsetName (Optional)
Charset mit dem die Binärdaten interpretiert werden sollen. Dieser Parameter ist Optional. Wird dieser Parameter nicht angegeben, wird UTF-8 verwendet.
Rückgabewert
Reader
Reader der Text-Binärdaten.
Bytes stream()
Liefert einen Stream auf die Binärdaten zurück. (Beispiel: <sp:print name="!{image.upload}.media.binary.stream()" encoding="base64"/>)
Rückgabewert
Stream
Stream der Binärdaten.


String toXip(Boolean emptyFields)
Erzeugt XML-Daten im XIP-Format für dieses Objekt.
Parameter
Boolean emptyFields
Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
Rückgabewert
String
XML-Daten im XIP-Format
Abgerufen von „https://wiki.sitepark.com/index.php?title=BinaryInformation_(Objekt)&oldid=9992“