Urlaubsplan
Lade ...
Suche ...
Keine Treffer
App::Controllers::Api::DepartmentController Klassenreferenz
Klassendiagramm für App::Controllers::Api::DepartmentController:
Zusammengehörigkeiten von App::Controllers::Api::DepartmentController:

Geschützte Methoden

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public index new OA Property (property:"data", type:"object", properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")])]))
 

Geschützte Attribute

 $modelName = 'App\Models\DepartmentModel'
 
 $format = 'json'
 
path : "/api/departments"
 HTTP-spezifischer Kontext.
 
path tags: ["Departments"]
 
path summary: "Retrieve all departments with manager and parent details"
 
path responses: [ new OA\Response( response: 200
 
path description: "List of departments retrieved successfully"
 
path content: new OA\JsonContent( properties: [ new OA\Property(property: "status"
 
path type: "string"
 
path example: "success")
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index() path: "/api/departments/{id}"
 HTTP-spezifischer Kontext.
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index tags: ["Departments"]
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index summary: "Retrieve a specific department by ID"
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index parameters: [ new OA\Parameter( name: "id"
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index in: "path"
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index required: true
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index description: "ID of the department"
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index schema: new OA\Schema(type: "integer"
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index example: 1) ) ]
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index responses: [ new OA\Response( response: 200
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index content: new OA\JsonContent( properties: [ new OA\Property(property: "status"
 
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index type: "string"
 

Ausführliche Beschreibung

DepartmentController

Controller zur Verwaltung der Abteilungen.

Dokumentation der Elementfunktionen

◆ Property()

path new OA App::Controllers::Api::DepartmentController::Property ( property:"data" ,
type:"object" ,
properties: [ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")] )
protected

Dokumentation der Datenelemente

◆ $format

App::Controllers::Api::DepartmentController::$format = 'json'
protected

◆ $modelName

App::Controllers::Api::DepartmentController::$modelName = 'App\Models\DepartmentModel'
protected

◆ __pad0__

path App::Controllers::Api::DepartmentController::__pad0__
protected

HTTP-spezifischer Kontext.

Liste aller Abteilungen mit Manager- und Parent-Details abrufen.

Rückgabe
Namespace: CodeIgniter
JSON-Antwort mit den Abteilungen

API-Endpunkt {get} /api/departments Liste aller Abteilungen abrufen

API Name: \1 GetDepartments
API Group: \1 Departments
API Success: \1 {Object[]} data Liste der Abteilungen
API Success: \1 {String} status Status der Anfrage

◆ content [1/2]

path App::Controllers::Api::DepartmentController::content
protected

◆ content [2/2]

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::content
protected

◆ description [1/2]

path App::Controllers::Api::DepartmentController::description
protected

◆ description [2/2]

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::description
protected

◆ example [1/2]

path App::Controllers::Api::DepartmentController::example
protected

◆ example [2/2]

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::example
protected

◆ in

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::in
protected

◆ parameters

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::parameters
protected

◆ path

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index() App::Controllers::Api::DepartmentController::path
protected

HTTP-spezifischer Kontext.

Einzelne Abteilung abrufen.

Parameter
int | null$idID der Abteilung
Rückgabe
Namespace: CodeIgniter
JSON-Antwort mit den Abteilungsdetails

API-Endpunkt {get} /api/departments/:id Einzelne Abteilung abrufen

API Name: \1 GetDepartmentById
API Group: \1 Departments
API Parameter: \1 {Number} id Die ID der Abteilung
API Success: \1 {Object} data Abteilungsdetails
API Error: \1 404 Abteilung nicht gefunden

◆ required

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::required
protected

◆ responses [1/2]

path App::Controllers::Api::DepartmentController::responses
protected

◆ responses [2/2]

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::responses
protected

◆ schema

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::schema
protected

◆ summary [1/2]

path App::Controllers::Api::DepartmentController::summary
protected

◆ summary [2/2]

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::summary
protected

◆ tags [1/2]

path App::Controllers::Api::DepartmentController::tags
protected

◆ tags [2/2]

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::tags
protected

◆ type [1/2]

path App::Controllers::Api::DepartmentController::type
protected

◆ type [2/2]

path new OA Property (property:"data", type:"array", items:new OA\Items( properties:[ new OA\Property(property:"id", type:"integer", example:1), new OA\Property(property:"name", type:"string", example:"IT Department"), new OA\Property(property:"manager", type:"string", example:"John Doe"), new OA\Property(property:"parent_department", type:"string", example:"Corporate")]))]))])] public function index App::Controllers::Api::DepartmentController::type
protected

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: