App::Controllers::AuthApi Klassenreferenz

Klassendiagramm für App::Controllers::AuthApi:

Zusammengehörigkeiten von App::Controllers::AuthApi:

Öffentliche Attribute
path	: "/api/login"
	HTTP-spezifischer Kontext.
path	tags: ["Authentication"]
path	summary: "Checks login status and displays login form if not logged in"
path	responses: [ new OA\Response( response: 200
path	description: "Login status response"
path	content: new OA\JsonContent( properties: [ new OA\Property(property: "message"
path	type: "string"
path	example: "Login required or already logged in") ] ) ) ] )] public function login() { if (session()->get('logged_in')) { return $this->respond(['message' => 'Already logged in']
path	: "/api/authenticate"
	HTTP-spezifischer Kontext.
path	requestBody: new OA\RequestBody( required: true
path new OA Property(property:"password", type:"string", example:"your_password")]))	responses: [ new OA\Response( response: 200
path new OA Property(property:"password", type:"string", example:"your_password")])	description: "Login successful"
path new OA Property(property:"password", type:"string", example:"your_password")]	content: new OA\JsonContent( properties: [ new OA\Property(property: "message"
path new OA Property(property:"password", type:"string", example:"your_password")]	type: "string"
path new OA Property(property:"password", type:"string", example:"your_password")]	example: "Login successful")
path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response(response:404, description:"Invalid login credentials", content:new OA\JsonContent(properties:[new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate()	path: "/api/logout"
	HTTP-spezifischer Kontext.
path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response(response:404, description:"Invalid login credentials", content:new OA\JsonContent(properties:[new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate	tags: ["Authentication"]
path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response(response:404, description:"Invalid login credentials", content:new OA\JsonContent(properties:[new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate	summary: "Logs out the user and destroys the session"
path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response(response:404, description:"Invalid login credentials", content:new OA\JsonContent(properties:[new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate	responses: [ new OA\Response( response: 200
path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response(response:404, description:"Invalid login credentials", content:new OA\JsonContent(properties:[new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate	description: "Logged out"
path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response(response:404, description:"Invalid login credentials", content:new OA\JsonContent(properties:[new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate	content: new OA\JsonContent( properties: [ new OA\Property(property: "message"
path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response(response:404, description:"Invalid login credentials", content:new OA\JsonContent(properties:[new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate	type: "string"
path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response(response:404, description:"Invalid login credentials", content:new OA\JsonContent(properties:[new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate	example: "Logged out") ] ) ) ] )] public function logout() { session()->destroy()
path	: "/api/register"
	HTTP-spezifischer Kontext.
path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property(property:"password", type:"string", example:"password123")]))	responses: [ new OA\Response( response: 200
path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property(property:"password", type:"string", example:"password123")])	description: "Registration successful"
path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property(property:"password", type:"string", example:"password123")]	content: new OA\JsonContent( properties: [ new OA\Property(property: "message"
path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property(property:"password", type:"string", example:"password123")]	type: "string"
path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property(property:"password", type:"string", example:"password123")]	example: "Registration successful")

Dokumentation der Datenelemente

__pad0__

path App::Controllers::AuthApi::__pad0__

HTTP-spezifischer Kontext.

Prüft den Anmeldestatus und zeigt ggf. das Anmeldeformular an.

Rückgabe

Namespace: CodeIgniter

__pad1__

path App::Controllers::AuthApi::__pad1__

HTTP-spezifischer Kontext.

Authentifiziert einen Benutzer anhand von E-Mail und Passwort.

Rückgabe

Namespace: CodeIgniter

__pad2__

path App::Controllers::AuthApi::__pad2__

HTTP-spezifischer Kontext.

Benutzer registrieren

Rückgabe

Namespace: CodeIgniter

content [1/4]

path App::Controllers::AuthApi::content

content [2/4]

path new OA Property (property:"password", type:"string", example:"your_password")] App::Controllers::AuthApi::content

content [3/4]

path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response (response:404, description:"Invalid login credentials", content:new OA\JsonContent( properties:[ new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate App::Controllers::AuthApi::content

content [4/4]

path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property (property:"password", type:"string", example:"password123")] App::Controllers::AuthApi::content

description [1/4]

path App::Controllers::AuthApi::description

description [2/4]

path new OA Property (property:"password", type:"string", example:"your_password")]) App::Controllers::AuthApi::description

description [3/4]

path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response (response:404, description:"Invalid login credentials", content:new OA\JsonContent( properties:[ new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate App::Controllers::AuthApi::description

description [4/4]

path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property (property:"password", type:"string", example:"password123")]) App::Controllers::AuthApi::description

example [1/4]

path App::Controllers::AuthApi::example

example [2/4]

path new OA Property (property:"password", type:"string", example:"your_password")] App::Controllers::AuthApi::example

example [3/4]

path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response (response:404, description:"Invalid login credentials", content:new OA\JsonContent( properties:[ new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate App::Controllers::AuthApi::example

example [4/4]

path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property (property:"password", type:"string", example:"password123")] App::Controllers::AuthApi::example

path

path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response (response:404, description:"Invalid login credentials", content:new OA\JsonContent( properties:[ new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate() App::Controllers::AuthApi::path

HTTP-spezifischer Kontext.

Meldet den Benutzer ab und zerstört die Sitzung.

Rückgabe

Namespace: CodeIgniter

requestBody

path App::Controllers::AuthApi::requestBody

responses [1/4]

path App::Controllers::AuthApi::responses

responses [2/4]

path new OA Property (property:"password", type:"string", example:"your_password")])) App::Controllers::AuthApi::responses

responses [3/4]

path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response (response:404, description:"Invalid login credentials", content:new OA\JsonContent( properties:[ new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate App::Controllers::AuthApi::responses

responses [4/4]

path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property (property:"password", type:"string", example:"password123")])) App::Controllers::AuthApi::responses

summary [1/2]

path App::Controllers::AuthApi::summary

summary [2/2]

path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response (response:404, description:"Invalid login credentials", content:new OA\JsonContent( properties:[ new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate App::Controllers::AuthApi::summary

tags [1/2]

path App::Controllers::AuthApi::tags

tags [2/2]

path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response (response:404, description:"Invalid login credentials", content:new OA\JsonContent( properties:[ new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate App::Controllers::AuthApi::tags

type [1/4]

path App::Controllers::AuthApi::type

type [2/4]

path new OA Property (property:"password", type:"string", example:"your_password")] App::Controllers::AuthApi::type

type [3/4]

path new OA Property(property:"password", type:"string", example:"your_password")] new OA Property(property:"user", type:"object", properties:[new OA\Property(property:"user_id", type:"integer", example:1), new OA\Property(property:"logged_in", type:"boolean", example:true)])])) new OA Response (response:404, description:"Invalid login credentials", content:new OA\JsonContent( properties:[ new OA\Property(property:"message", type:"string", example:"Invalid login credentials")]))])] public function authenticate App::Controllers::AuthApi::type

type [4/4]

path new OA Property(property:"last_name", type:"string", example:"Mustermann") new OA Property(property:"email", type:"string", example:"max@example.com") new OA Property (property:"password", type:"string", example:"password123")] App::Controllers::AuthApi::type

---

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

• app/Controllers/AuthApi.php