> For the complete documentation index, see [llms.txt](https://docs.chamilo.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chamilo.org/3.x/de/entwicklerleitfaden/developer-guide/api/custom-actions.md).

# Benutzerdefinierte Aktionen

Neben den Standard-CRUD-Operationen verfügt Chamilo über eine Reihe benutzerdefinierter API-Aktionscontroller (im zweistelligen Bereich), die spezialisierte Operationen abwickeln. Die genaue Anzahl variiert zwischen den Releases — listen Sie `src/CoreBundle/Controller/Api/` für den aktuellen Satz auf.

## Speicherort

Benutzerdefinierte Aktionen befinden sich in `src/CoreBundle/Controller/Api/`.

## Bemerkenswerte benutzerdefinierte Aktionen

### Dokumente

| Controller                        | Zweck                                                           |
| --------------------------------- | --------------------------------------------------------------- |
| `CreateDocumentFileAction`        | Eine Datei hochladen oder ein Ordner-/Link-Dokument erstellen   |
| `UpdateDocumentFileAction`        | Die Datei eines Dokuments ersetzen                              |
| `ReplaceDocumentFileAction`       | Eine Dokumentdatei ersetzen und dabei ihre IDs beibehalten      |
| `MoveDocumentAction`              | Ein Dokument in einen anderen Ordner verschieben                |
| `UpdateVisibilityDocument`        | Die Sichtbarkeit eines Dokuments für Lernende umschalten        |
| `DownloadAllDocumentsAction`      | Alle Dokumente in einem Ordner als ZIP herunterladen            |
| `DownloadSelectedDocumentsAction` | Eine ausgewählte Menge von Dokumenten als ZIP herunterladen     |
| `DocumentUsageAction`             | Kurse/Sitzungen auflisten, in denen ein Dokument verwendet wird |
| `DocumentLearningPathUsageAction` | Lernpfade auflisten, in denen ein Dokument verwendet wird       |

### Glossar

| Controller                        | Zweck                                                     |
| --------------------------------- | --------------------------------------------------------- |
| `CreateCGlossaryAction`           | Einen Glossarbegriff erstellen                            |
| `UpdateCGlossaryAction`           | Einen Glossarbegriff aktualisieren                        |
| `ExportCGlossaryAction`           | Glossar in eine Datei exportieren                         |
| `ImportCGlossaryAction`           | Glossar aus einer Datei importieren                       |
| `ExportGlossaryToDocumentsAction` | Glossar als Dokument im Kurs exportieren                  |
| `GetGlossaryCollectionController` | Glossarsammlung mit benutzerdefinierter Filterung abrufen |

### Links

| Controller                     | Zweck                                                   |
| ------------------------------ | ------------------------------------------------------- |
| `CreateCLinkAction`            | Einen externen Link erstellen                           |
| `UpdateCLinkAction`            | Einen externen Link aktualisieren                       |
| `CreateCLinkCategoryAction`    | Eine Link-Kategorie erstellen                           |
| `UpdateCLinkCategoryAction`    | Eine Link-Kategorie aktualisieren                       |
| `CheckCLinkAction`             | Prüfen, ob eine Link-URL erreichbar ist                 |
| `ExportCLinksAction`           | Links in eine Datei exportieren                         |
| `CLinkDetailsController`       | Link-Details abrufen                                    |
| `CLinkImageController`         | Das Vorschaubild eines Links abrufen oder setzen        |
| `GetLinksCollectionController` | Link-Sammlung mit benutzerdefinierter Filterung abrufen |
| `UpdateVisibilityLink`         | Die Sichtbarkeit eines Links umschalten                 |
| `UpdateVisibilityLinkCategory` | Die Sichtbarkeit einer Link-Kategorie umschalten        |
| `UpdatePositionLink`           | Links neu anordnen                                      |

### Lernpfade

| Controller            | Zweck                         |
| --------------------- | ----------------------------- |
| `CreateCLpAction`     | Einen Lernpfad erstellen      |
| `LpReorderController` | Lernpfadelemente neu anordnen |

### Kalender

| Controller                         | Zweck                                                 |
| ---------------------------------- | ----------------------------------------------------- |
| `UpdateCCalendarEventAction`       | Ein Kurskalenderereignis aktualisieren                |
| `CalendarMyStudentsScheduleAction` | Den Zeitplan der Studierenden einer Lehrkraft abrufen |

### Blog

| Controller                   | Zweck                                    |
| ---------------------------- | ---------------------------------------- |
| `CreateCBlogAction`          | Einen Blogbeitrag erstellen              |
| `CreateBlogAttachmentAction` | Eine Datei an einen Blogbeitrag anhängen |
| `UpdateVisibilityBlog`       | Die Sichtbarkeit des Blogs umschalten    |

### Dropbox

| Controller                | Zweck                                                        |
| ------------------------- | ------------------------------------------------------------ |
| `CreateDropboxFileAction` | Eine Datei in die Dropbox (Dateiaustauschwerkzeug) hochladen |

### Studierendenarbeiten (Aufgaben)

| Controller                                     | Zweck                                              |
| ---------------------------------------------- | -------------------------------------------------- |
| `CreateStudentPublicationFileAction`           | Eine Aufgabendatei einreichen                      |
| `CreateStudentPublicationCommentAction`        | Einen Kommentar zu einer Einreichung hinzufügen    |
| `CreateStudentPublicationCorrectionFileAction` | Eine Korrekturdatei für eine Einreichung hochladen |

### Persönliche Dateien

| Controller                 | Zweck                                                               |
| -------------------------- | ------------------------------------------------------------------- |
| `CreatePersonalFileAction` | Eine Datei in den persönlichen Dateibereich des Benutzers hochladen |
| `UpdatePersonalFileAction` | Eine persönliche Datei aktualisieren                                |

### Soziales Netzwerk

| Controller                             | Zweck                                                   |
| -------------------------------------- | ------------------------------------------------------- |
| `LikeSocialPostController`             | Einen sozialen Beitrag liken                            |
| `DislikeSocialPostController`          | Das Like eines sozialen Beitrags entfernen              |
| `CreateSocialPostAttachmentAction`     | Eine Datei an einen sozialen Beitrag anhängen           |
| `SocialPostAttachmentsController`      | Anhänge eines sozialen Beitrags auflisten               |
| `AbstractFeedbackSocialPostController` | Basisklasse für Feedback-Aktionen zu sozialen Beiträgen |

### Sitzungen

| Controller                               | Zweck                                                                        |
| ---------------------------------------- | ---------------------------------------------------------------------------- |
| `CreateSessionWithUsersAndCoursesAction` | Eine Sitzung erstellen und Benutzer sowie Kurse in einem Aufruf einschreiben |

### Benutzer & Access URLs

| Controller                    | Zweck                                                      |
| ----------------------------- | ---------------------------------------------------------- |
| `CreateUserOnAccessUrlAction` | Einen Benutzer erstellen und ihn einer Access URL zuordnen |
| `UserAccessUrlsController`    | Access URLs auflisten, zu denen ein Benutzer gehört        |
| `UserSkillsController`        | Einem Benutzer verliehene Kompetenzen auflisten            |

### Videokonferenz

| Controller                          | Zweck                                                 |
| ----------------------------------- | ----------------------------------------------------- |
| `VideoConferenceCallbackController` | Callbacks externer Videokonferenzanbieter verarbeiten |

### Basisklassen

| Class                    | Zweck                                                                                                               |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------- |
| `BaseResourceFileAction` | Basisklasse für Datei-Upload-Aktionen; übernimmt Multipart-Parsing, Erstellung von Ressourcenknoten und Speicherung |

## Implementierung einer Custom Action

Custom Actions sind Standard-Symfony-Controller, die in den Operationsdefinitionen von API Platform referenziert werden. Das Attribut `#[ApiResource]` befindet sich auf der **Entität**, und der Parameter `controller:` jeder Operation verweist auf die Action-Klasse:

```php
// On the entity class (e.g. src/CourseBundle/Entity/CDocument.php):
#[ApiResource(
    shortName: 'Document',
    operations: [
        new Post(
            controller: CreateDocumentFileAction::class,
            deserialize: false,
        ),
        new Put(
            uriTemplate: '/documents/{iid}/move',
            controller: MoveDocumentAction::class,
            deserialize: false,
        ),
    ]
)]
class CDocument extends AbstractResource { ... }
```

Die Action-Klasse selbst ist ein einfacher aufrufbarer Controller — Dienste werden über die Argumente der Methode `__invoke()` injiziert:

```php
namespace Chamilo\CoreBundle\Controller\Api;

use Chamilo\CourseBundle\Entity\CDocument;
use Symfony\Component\HttpFoundation\Request;

final class CreateDocumentFileAction extends BaseResourceFileAction
{
    public function __invoke(
        Request $request,
        CDocumentRepository $repo,
        // ... other injected services
    ): CDocument {
        // Handle the upload and return the entity
    }
}
```

Wichtige Punkte:

* `deserialize: false` wird gesetzt, wenn die Action die Anfrage direkt liest (z. B. Multipart-Datei-Uploads), anstatt API Platform einen JSON-Body deserialisieren zu lassen.
* Datei-Upload-Actions erweitern in der Regel `BaseResourceFileAction`, das das Parsen von Multipart-Daten und die Verdrahtung der Resource Nodes übernimmt.
* Die Sicherheit wird über den Parameter `security:` der Operation durchgesetzt, nicht innerhalb des Controllers.