Skip to content

[CODINGSTANDARD] Copy-and-paste-PHPDocs, Tippfehler und inkonsistente API-Namen korrigieren #556

Description

@ralferlebach

Problem

Mehrere PHPDocs beziehen sich fälschlich auf Catquiz, „next question“ oder das Assign-Modul. Öffentliche und interne Namen enthalten Tippfehler wie visiblity, sacleid, complition und get_internalquuiz_id.

Ursache

Klassen und Services wurden kopiert und erweitert, ohne Dokumentation und Namen vollständig anzupassen.

Lösung

  • PHPDocs funktionsspezifisch neu formulieren.
  • Interne Tippfehler direkt umbenennen.
  • Öffentliche External-Function-Namen über kompatible Deprecation migrieren.
  • Frontend-Aufrufer und Tests aktualisieren.

Manuelles Testverfahren

Testschritte

  1. API-Aufrufe mit altem und neuem Namen testen.
  2. Generierte API-Dokumentation prüfen.

Aktuelles Ist-Verhalten

Mehrere PHPDocs beziehen sich fälschlich auf Catquiz, „next question“ oder das Assign-Modul. Öffentliche und interne Namen enthalten Tippfehler wie visiblity, sacleid, complition und get_internalquuiz_id.

Erwartetes Soll-Verhalten

Keine fachfremden Komponentenbezüge.

Automatisierte Tests

  • Deprecation- und BC-Test.
  • PHPCS/PHPDoc-Check.

Akzeptanzkriterien

  • Keine fachfremden Komponentenbezüge.
  • Öffentliche Umbenennungen besitzen Migrationspfad.
  • Neue Namen sind konsistent und korrekt geschrieben.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions