Media (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (Hob den Schutz von „Media (Objekt)“ auf)
 
(8 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 6: Zeile 6:
  
 
==Attribute==
 
==Attribute==
−
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 24: Zeile 24:
 
| ID-Teil ohne Typ-Definition
 
| ID-Teil ohne Typ-Definition
 
| 1
 
| 1
 +
|-
 +
| withoutSignature
 +
| [[Number]]
 +
| ID-Teil ohne Signatur- und Typ-Definition
 +
| 2.1.0.13
 
|-
 
|-
 
| type
 
| type
Zeile 73: Zeile 78:
 
| [[String]]
 
| [[String]]
 
| Dateiname des Objektes
 
| Dateiname des Objektes
 +
| 1
 +
|-
 +
| originalFilename
 +
| [[String]]
 +
| Dateiname, der nicht vom System angepasst wurde
 
| 1
 
| 1
 
|-
 
|-
Zeile 106: Zeile 116:
 
|-
 
|-
 
| stepParents
 
| stepParents
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[ArticlePool]]>
 
| Liefert eine leere Liste, da es für Medien keine [[Symbolischer Link|sysmbolischen Links]] gibt
 
| Liefert eine leere Liste, da es für Medien keine [[Symbolischer Link|sysmbolischen Links]] gibt
 
| 1
 
| 1
 
|-
 
|-
 
| path
 
| path
−
| [[Collection]]
+
| [[Collection]]<[[ArticlePool]]/[[Media]]>
 
| Liste aller übergeordenten Articlepools und dieses Medium. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist <code>parent</code>. Das letzte Element der Liste ist dieses Medium
 
| Liste aller übergeordenten Articlepools und dieses Medium. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist <code>parent</code>. Das letzte Element der Liste ist dieses Medium
 
| 1
 
| 1
Zeile 166: Zeile 176:
 
|-
 
|-
 
| history
 
| history
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[HistoryEntry]]>
 
| Liste von [[HistoryEntry]]-Objekten, die alle Aktionen auf dieses Objekte beschreiben
 
| Liste von [[HistoryEntry]]-Objekten, die alle Aktionen auf dieses Objekte beschreiben
 
| 1
 
| 1
Zeile 176: Zeile 186:
 
|-
 
|-
 
| all
 
| all
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Information]]>
 
| Liefert eine Liste alle [[Information|Informations]]-Objekte
 
| Liefert eine Liste alle [[Information|Informations]]-Objekte
 
| 1
 
| 1
 
|-
 
|-
 
| flat
 
| flat
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[Information]]>
 
| Liefert eine Liste aller [[Information|Informations]]-Objekte ohne Struktierungs-Objekt wie [[ListInformation|ListInformations]], [[ListItemInformation|ListItemInformations]] oder [[SubInformation|SubInformations]]
 
| Liefert eine Liste aller [[Information|Informations]]-Objekte ohne Struktierungs-Objekt wie [[ListInformation|ListInformations]], [[ListItemInformation|ListItemInformations]] oder [[SubInformation|SubInformations]]
 
| 1
 
| 1
Zeile 211: Zeile 221:
 
|-
 
|-
 
| publicationStates
 
| publicationStates
−
| [[Collection]]
+
| [[Collection]]&nbsp;<[[PublicationState]]>
 
| Liste von [[PublicationState]]-Objekten, die die Stati für jeden [[Publisher]], in denen dieses Objekt publiziert ist, enthalten.
 
| Liste von [[PublicationState]]-Objekten, die die Stati für jeden [[Publisher]], in denen dieses Objekt publiziert ist, enthalten.
 
| 1
 
| 1
 +
|-
 +
| publishedIn
 +
| [[Collection]]&nbsp;<[[Publisher]]>
 +
| Liste von [[Publisher]]-Objekten, in denen das Medium publiziert ist
 +
| 2.1.0
 +
|-
 +
| referrerLinks
 +
| [[Collection]]&nbsp;<[[IDLink]]>
 +
| Liste von [[IDLink]]-Objekten, die die Links auf dieses Medium beschreiben.
 +
| 2.1.0
 
|-
 
|-
 
| ???
 
| ???
Zeile 255: Zeile 275:
 
| Liefert für den angegebenen Publisher das Publikationsstatus.
 
| Liefert für den angegebenen Publisher das Publikationsstatus.
 
| 1
 
| 1
 +
|-
 +
| <code>referrerLinks([[String]] name)</code>
 +
| [[Collection]]<[[IDLink]]>
 +
| Liste von [[IDLink]]-Objekten, die die Links auf dieses Medium beschreiben.
 +
| 2.1.0
 
|}
 
|}
  
Zeile 278: Zeile 303:
 
:Liefert die URL des Mediums, wenn das Medium für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (<code>/</code>) ausgegeben.
 
:Liefert die URL des Mediums, wenn das Medium für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (<code>/</code>) ausgegeben.
 
:;Parameter
 
:;Parameter
−
::;<code>[[Publisher]]</code>
+
::;<code>Publisher</code>
 
:::Publisher, für den die URL zurückgegeben werden soll.
 
:::Publisher, für den die URL zurückgegeben werden soll.
 
:;Rückgabewert
 
:;Rückgabewert
−
::;[[URL]]
+
::;URL
 
:::URL des Mediums für den angegebenen Publisher ausgehend vom Dokument-Root (<code>/</code>).
 
:::URL des Mediums für den angegebenen Publisher ausgehend vom Dokument-Root (<code>/</code>).
  
Zeile 310: Zeile 335:
 
::;PublicationState
 
::;PublicationState
 
:::Publikations-Status des Mediums für den angegebenen Publisher.
 
:::Publikations-Status des Mediums für den angegebenen Publisher.
 +
 +
;<code>[[Collection]]<[[IDLink]]> referrerLinks([[String]] name)</code>
 +
:Liste von [[IDLink]]-Objekten, die die Links auf dieses Medium beschreiben.
 +
:;Parameter
 +
::;<code>name</code>
 +
:::Name des Feldes über den der Link angelegt wurde. Hier wird wie bei Suchabfragen der 'Suchname' angegeben. Z.B. <code>mylink.link</code>
 +
:;Rückgabewert
 +
::;Collection<IDLink>
 +
:::Liste der Links, die auf das Medium verweisen
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 24. Februar 2010, 12:24 Uhr

Name

Media - Medium, Binärdaten wie Bilder, PDFs, ...

Beschreibung

Medien sind binäre Daten wie Bilder, PDFs, Office-Dokumente usw. Für Medien werden vom Publisher keine Seiten generiert, sondern lediglich die Binärdaten als Dateien im File-System abgelegt. Für Medien wird aus diesem Grund kein Ausgabe-Template benötigt. Mit Hilfe von Eingabe-Templates können aber weitere Daten für die Medien eingetragen werden. Im Gegensatz zu Resourcen können für Medien keine Symbolischen Links erzeugt werden.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Artikels 1
original ID ist identisch mit id, da es für Medien keine sysmbolischen Links gibt 1
withoutType Number ID-Teil ohne Typ-Definition 1
withoutSignature Number ID-Teil ohne Signatur- und Typ-Definition 2.1.0.13
type system.constants.MEDIA_ARTICLE Typ des Mediums 1
category system.constants.INFORMATION Typ des Objektes 1
version Date Die Version des Objekts entspricht dem Zeitstempel, zu dem dieser Stand erzeugt wurde 1
anchor Anchor Anchor des Objektes 1
name String Name des Objektes in der default-Sprache 1
localeName String Sprachenspezifischer Name. Welche Sprache verwendet wird, wird über das locale-Attribute der Ausgabe-Tags bestimmt 1
comment String Kommentar zu dem Objekt in der default-Sprache 1
localeComment Text Sprachenspezifischer Kommentar. Welche Sprache verwendet wird, wird über das locale-Attribute der Ausgabe-Tags bestimmt. 1
parent ArticlePool Artikelpool in dem das Objekt liegt 1
filename String Dateiname des Objektes 1
originalFilename String Dateiname, der nicht vom System angepasst wurde 1
mime String Mime-Type des Mediums 1
format String Format des Mediums. Beispielsweise png, gif, pdf, ... 1
filesize Number Größe des Mediums in Bytes 1
isImage Boolean true, wenn es sich bei dem Medium um ein Bild handelt 1
width Number Breite in Pixel, wenn es sich bei dem Medium um ein Bild handelt, sonst 0 1
height Number Höhe in Pixel, wenn es sich bei dem Medium um ein Bild handelt, sonst 0 1
stepParents Collection <ArticlePool> Liefert eine leere Liste, da es für Medien keine sysmbolischen Links gibt 1
path Collection<ArticlePool/Media> Liste aller übergeordenten Articlepools und dieses Medium. Das erste Element der Liste ist der Root-Pool. Das zweitletzte Element der Liste ist parent. Das letzte Element der Liste ist dieses Medium 1
createdBy User Nutzer, der dieses Objekt erzeugt hat 1
created Date Datum und Uhrzeit, zu dem dieses Objekt erzeugt wurde 1
changedBy User Nutzer, der dieses Objekt zuletzt geändert hat 1
changed Date Datum und Uhrzeit, zu dem dieses Objekt das letzte mal geändert wurde 1
permissions Permission Gibt an, welche Rechte der Nutzer, der dieses Objekt angefordert hat, auf dieses Objekt besitzt 1
lock Lock Wenn dieses Attribut gesetzt ist, ist das Objekt von einem anderen Nutzer gelockt 2
isReadOnly Boolean true, wenn der Nutzer, der dieses Objekt angefordert hat nur lesend darauf zugreifen darf. Dies ist der Fall, wenn der Nutzer nur Leserechte auf diese Objekt hat oder das Objekt von einem anderen Nutzer gelockt wurde 1
isElement Boolean ist immer true 1
isPool Boolean ist immer false 1
isSymbolicLink Boolean immer false, da es für Medien keine sysmbolischen Links gibt 1
history Collection <HistoryEntry> Liste von HistoryEntry-Objekten, die alle Aktionen auf dieses Objekte beschreiben 1
isEmpty Boolean true, wenn dieses Objekt keine Informations-Objekte enthält 1
all Collection <Information> Liefert eine Liste alle Informations-Objekte 1
flat Collection <Information> Liefert eine Liste aller Informations-Objekte ohne Struktierungs-Objekt wie ListInformations, ListItemInformations oder SubInformations 1
isPublished Boolean Dieses Attribute ist im Out-Modus gültig. Es zeigt an, ob dieses Objekt für den aktuellen Publisher freigegeben ist 1
hasValidUrl (deprecated) Boolean Liefert true im Out-Modus, wenn dieses Objekt für den aktuellen Publisher freigegeben ist 1
url URL Liefert im Out-Modus die URL dieses Objekt, wenn das Objekt für den aktuellen Publisher freigegeben ist. Mit diesem Attribute wird die URL ohne http://www.domain.de ausgegeben. Sie beginnt mit / ab dem Dokument-Root 1
absoluteUrl URL Liefert im Out-Modus die URL dieses Objekt, wenn das Objekt für den aktuellen Publisher freigegeben ist. Mit diesem Attribute wird die URL mit http://www.domain.de ausgegeben. 1
relativeUrl URL Liefert im Out-Modus die URL des Artikels, wenn dieses Objekt für den aktuellen Publisher freigegeben ist. Mit diesem Attribut wird die URL relativ zu dem aktuellen Artikel ausgegeben. 1
publicationStates Collection <PublicationState> Liste von PublicationState-Objekten, die die Stati für jeden Publisher, in denen dieses Objekt publiziert ist, enthalten. 1
publishedIn Collection <Publisher> Liste von Publisher-Objekten, in denen das Medium publiziert ist 2.1.0
referrerLinks Collection <IDLink> Liste von IDLink-Objekten, die die Links auf dieses Medium beschreiben. 2.1.0
??? ??? Ein Medium kann beliebig viele weitere Attribute enthalten. Dies können normale Textfelder, aber auch Listen-, BinärInformation usw. sein. Alleine das Template zur Erzeugung und Änderung von Medien bestimmt diese Attribute. 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
isPublished(Publisher publisher) Boolean Liefert true, wenn das Medium für den angegebenen Publisher publiziert ist. 1
hasValidUrl(Publisher publisher) Boolean Liefert true, wenn das Medium für den angegebenen Publisher publiziert ist und eine URL zurückliefert. 1
url(Publisher publisher) URL Liefert die URL des Mediums, wenn das Medium für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (/) ausgegeben. 1
absoluteUrl(Publisher publisher) URL Liefert die URL des Mediums, wenn das Medium für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL mit vorangestelltem http://www.domain.de ausgegeben. 1
relativeUrl(Publisher publisher) URL Liefert die URL des Mediums, wenn das Medium für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL relativ zu dem aktuellen Artikel ausgegeben. 1
publicationState(Publisher publisher) PublicationState Liefert für den angegebenen Publisher das Publikationsstatus. 1
referrerLinks(String name) Collection<IDLink> Liste von IDLink-Objekten, die die Links auf dieses Medium beschreiben. 2.1.0
Boolean isPublished(Publisher publisher)
Liefert true, wenn das Medium für den angegebenen Publisher publiziert ist.
Parameter
Publisher
Publisher, für den geprüft werden soll, ob das Medium für diesen publiziert ist.
Rückgabewert
Boolean
true, wenn das Medium in dem angegebenen Publisher publiziert ist.
Boolean hasValidUrl(Publisher publisher)
Liefert true, wenn das Medium für den angegebenen Publisher publiziert ist und eine URL zurückliefert.
Parameter
Publisher
Publisher, für den die URL geprüft werden soll.
Rückgabewert
Boolean
true, wenn das Medium für den angegebenen Publisher publiziert ist.
URL url(Publisher publisher)
Liefert die URL des Mediums, wenn das Medium für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL beginnend ab dem Dokument-Root (/) ausgegeben.
Parameter
Publisher
Publisher, für den die URL zurückgegeben werden soll.
Rückgabewert
URL
URL des Mediums für den angegebenen Publisher ausgehend vom Dokument-Root (/).
URL absoluteUrl(Publisher publisher)
Liefert die URL des Mediums, wenn das Medium für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL mit http://www.domain.de ausgegeben.
Parameter
Publisher
Publisher, für den die URL zurückgegeben werden soll.
Rückgabewert
URL
URL des Mediums für den angegebenen Publisher mit http://www.domain.de.
URL relativeUrl(Publisher publisher)
Liefert die URL des Mediums , wenn das Medium für den angegebenen Publisher freigegeben ist. Mit dieser Methode wird die URL relativ zu dem aktuellen Aritkel ausgegeben.
Parameter
Publisher
Publisher, für den die URL zurückgegeben werden soll.
Rückgabewert
URL
URL des Mediums für den angegebenen Publisher relativ zu dem aktuellen Artikel.
PublicationState publicationState(Publisher publisher)
Liefert den Publikations-Status des Mediums für den angegebenen Publisher.
Parameter
Publisher
Publisher für den der Publikations-Status ausgegeben werden soll.
Rückgabewert
PublicationState
Publikations-Status des Mediums für den angegebenen Publisher.
Collection<IDLink> referrerLinks(String name)
Liste von IDLink-Objekten, die die Links auf dieses Medium beschreiben.
Parameter
name
Name des Feldes über den der Link angelegt wurde. Hier wird wie bei Suchabfragen der 'Suchname' angegeben. Z.B. mylink.link
Rückgabewert
Collection<IDLink>
Liste der Links, die auf das Medium verweisen
Abgerufen von „https://wiki.sitepark.com/index.php?title=Media_(Objekt)&oldid=4584“