Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zusätzliche Docs für neues_entry #38

Merged
merged 1 commit into from
Dec 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
219 changes: 217 additions & 2 deletions docs/03_neues_entry.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ $entries = neues_entry::findOnline(); // Alle Online-Einträge
$entries = neues_entry::findByCategory($category_id [, $status]) // Alle Einträge einer Kategorie
```

## Beispiel-Ausgabe einer News
## Methoden und Beispiele

```php
$entry = neues_entry::get(3); // News mit der id=3
Expand All @@ -29,7 +29,6 @@ echo $entry->getDescription();
echo $entry->getExternalUrl();
echo $entry->getExternalLabel();
echo $entry->getPublishDate();
echo $entry->getPublishDateTime();
echo $entry->getFormattedPublishDate($format); // IntlDateFormatter::FULL
echo $entry->getFormattedPublishDateTime($format); // [IntlDateFormatter::FULL, IntlDateFormatter::SHORT]
echo $entry->getStatus();
Expand All @@ -44,3 +43,219 @@ foreach($categories as $category) {
// ...
}
```

### getName()

Gibt den Namen des Eintrags zurück.

```php
$name = $entry->getName();
```

### setName(string $name)

Setzt den Namen des Eintrags.

```php
$entry = $entry->setName('Neuer Name');
```

### getAuthor()

Gibt den Autor des Eintrags zurück oder null, wenn kein Autor gesetzt ist.

```php
$author = $entry->getAuthor();
```

### getDomain()

Gibt die Domain des Eintrags zurück.

```php
$domain = $entry->getDomain();
```

### setDomain(mixed $domain)

Setzt die Domain des Eintrags.

```php
$entry = $entry->setDomain('neue-domain.com');
```

### getTeaser()

Gibt den Teaser des Eintrags zurück.

```php
$teaser = $entry->getTeaser();
```

### getCategories()

Gibt die Kategorien des Eintrags zurück oder null, wenn keine Kategorien gesetzt sind.

```php
$categories = $entry->getCategories();
```

### getImage()

Gibt das Bild des Eintrags zurück.

```php
$image = $entry->getImage();
```

### setImage(string $image)

Setzt das Bild des Eintrags.

```php
$entry = $entry->setImage('neues_bild.jpg');
```

### getImages()

Gibt die Bilder des Eintrags zurück oder null, wenn keine Bilder gesetzt sind.

```php
$images = $entry->getImages();
```

### setImages(?array $images)

Setzt die Bilder des Eintrags.

```php
$entry = $entry->setImages(['bild1.jpg', 'bild2.jpg']);
```

### getMedia()

Gibt das Medium des Eintrags zurück oder null, wenn kein Medium gesetzt ist.

```php
$media = $entry->getMedia();
```

### setMedia(?rex_media $media)

Setzt das Medium des Eintrags.

```php
$entry = $entry->setMedia($newMedia);
```

### getDescriptionAsPlaintext()

Gibt die Beschreibung des Eintrags als reinen Text zurück.

```php
$descriptionPlainText = $entry->getDescriptionAsPlaintext();
```

### getDescription()

Gibt die Beschreibung des Eintrags zurück.

```php
$description = $entry->getDescription();
```

### setDescription(string $description)

Setzt die Beschreibung des Eintrags.

```php
$entry = $entry->setDescription('Neue Beschreibung');
```

### getExternalUrl()

Gibt die externe URL des Eintrags zurück oder null, wenn keine URL gesetzt ist.

```php
$externalUrl = $entry->getExternalUrl();
```

### setExternalUrl(string $url)

Setzt die externe URL des Eintrags.

```php
$entry = $entry->setExternalUrl('http://neue-url.com');
```

### getPublishDate()

Gibt das Veröffentlichungsdatum des Eintrags zurück.

```php
$publishDate = $entry->getPublishDate();
```

### setPublishDate(string $publishdate)

Setzt das Veröffentlichungsdatum des Eintrags.

```php
$entry = $entry->setPublishDate('2022-01-01');
```

### getFormattedPublishDate($format_date = IntlDateFormatter::FULL)

Gibt das formatierte Veröffentlichungsdatum des Eintrags zurück.

```php
$formattedPublishDate = $entry->getFormattedPublishDate(IntlDateFormatter::FULL);
```

### getFormattedPublishDateTime($format = [IntlDateFormatter::FULL, IntlDateFormatter::SHORT])

Gibt das formatierte Veröffentlichungsdatum und -zeit des Eintrags zurück.

```php
$formattedPublishDateTime = $entry->getFormattedPublishDateTime([IntlDateFormatter::FULL, IntlDateFormatter::SHORT]);
```

### getStatus()

Gibt den Status des Eintrags zurück.

```php
$status = $entry->getStatus();
```

### setStatus(int $status)

Setzt den Status des Eintrags.

```php
$entry = $entry->setStatus(1);
```

### findOnline(?int $category_id = null)

Findet Online-Einträge. Wenn eine Kategorie-ID angegeben ist, werden nur Einträge aus dieser Kategorie zurückgegeben.

```php
$entries = neues_entry::findOnline(1);
```

### findByCategory(?int $category_id = null, int $status = 1)

Findet Einträge nach Kategorie.

```php
$entries = neues_entry::findByCategory(1, 1);
```

### getUrl(string $profile = 'neues-entry-id')

Gibt die URL des Eintrags zurück.

```php
$url = $entry->getUrl();
```
Loading