Klassendiagramm für App::Controllers::Api::AdminSettings:

Zusammengehörigkeiten von App::Controllers::Api::AdminSettings:

Geschützte Methoden
path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA	Property (property:"value", type:"string", example:"New Website Name")]))

Geschützte Attribute
	$modelName = 'App\Models\SettingsModel'

	$format = 'json'

path	: "/api/admin-settings"
	HTTP-spezifischer Kontext.

path	tags: ["Admin Settings"]

path	summary: "Retrieve all administrative settings"

path	responses: [ new OA\Response( response: 200

path	description: "Settings 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:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings()	path: "/api/admin-settings"
	HTTP-spezifischer Kontext.

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings	tags: ["Admin Settings"]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings	summary: "Update a specific administrative setting"

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings	requestBody: new OA\RequestBody( required: true

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings	content: new OA\JsonContent( properties: [ new OA\Property(property: "key"

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings	type: "string"

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings	example: "site_name")

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA	responses: [ new OA\Response( response: 200

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA	description: "Setting updated successfully"

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA	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:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA	type: "string"

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA	example: "success")

Ausführliche Beschreibung

AdminSettings Controller

Controller zum Verwalten der administrativen Einstellungen.

Dokumentation der Elementfunktionen

◆ Property()

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA App::Controllers::Api::AdminSettings::Property	(	property:"value"	,
		type:"string"	,
		example:"New Website Name"	)

protected

Dokumentation der Datenelemente

◆ $format

App::Controllers::Api::AdminSettings::$format = 'json'

protected

◆ $modelName

App::Controllers::Api::AdminSettings::$modelName = 'App\Models\SettingsModel'

protected

◆ pad0

path App::Controllers::Api::AdminSettings::__pad0__

protected

HTTP-spezifischer Kontext.

Abrufen aller Einstellungen

Diese Methode gibt alle administrativen Einstellungen zurück.

Rückgabe: Namespace: CodeIgniter; JSON-Antwort mit den Einstellungen oder einer Fehlermeldung

API-Endpunkt {get} /api/admin-settings Abrufen aller Einstellungen

API Name: \1 GetSettings

API Group: \1 AdminSettings

API Success: \1 {String} status Status der Anfrage (success)

API Success: \1 {Object[]} data Liste der Einstellungen

API Error: \1 500 Das Settings-Modell konnte nicht geladen werden.

◆ content [1/3]

path App::Controllers::Api::AdminSettings::content

protected

◆ content [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response (response:500, description:"Settings model could not be loaded", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings App::Controllers::Api::AdminSettings::content

protected

◆ content [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA App::Controllers::Api::AdminSettings::content

protected

◆ description [1/2]

path App::Controllers::Api::AdminSettings::description

protected

◆ description [2/2]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA App::Controllers::Api::AdminSettings::description

protected

◆ example [1/3]

path App::Controllers::Api::AdminSettings::example

protected

◆ example [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response (response:500, description:"Settings model could not be loaded", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings App::Controllers::Api::AdminSettings::example

protected

◆ example [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA App::Controllers::Api::AdminSettings::example

protected

◆ path

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response (response:500, description:"Settings model could not be loaded", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings() App::Controllers::Api::AdminSettings::path

protected

HTTP-spezifischer Kontext.

Aktualisieren einer Einstellung

Diese Methode aktualisiert eine spezifische Einstellung basierend auf Schlüssel und Wert.

Rückgabe: Namespace: CodeIgniter; JSON-Antwort mit Erfolgs- oder Fehlermeldung

API-Endpunkt {put} /api/admin-settings Aktualisieren einer Einstellung

API Name: \1 UpdateSetting

API Group: \1 AdminSettings

API Parameter: \1 {String} key Der Schlüssel der Einstellung

API Parameter: \1 {String} value Der neue Wert der Einstellung

API Success: \1 {String} status Status der Anfrage (success)

API Success: \1 {String} message Erfolgsnachricht

API Error: \1 400 Ungültige Eingabe

◆ requestBody

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response (response:500, description:"Settings model could not be loaded", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings App::Controllers::Api::AdminSettings::requestBody

protected

◆ responses [1/2]

path App::Controllers::Api::AdminSettings::responses

protected

◆ responses [2/2]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA App::Controllers::Api::AdminSettings::responses

protected

◆ summary [1/2]

path App::Controllers::Api::AdminSettings::summary

protected

◆ summary [2/2]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response (response:500, description:"Settings model could not be loaded", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings App::Controllers::Api::AdminSettings::summary

protected

◆ tags [1/2]

path App::Controllers::Api::AdminSettings::tags

protected

◆ tags [2/2]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response (response:500, description:"Settings model could not be loaded", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings App::Controllers::Api::AdminSettings::tags

protected

◆ type [1/3]

path App::Controllers::Api::AdminSettings::type

protected

◆ type [2/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response (response:500, description:"Settings model could not be loaded", content:new OA\JsonContent( properties:[ new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public function getSettings App::Controllers::Api::AdminSettings::type

protected

◆ type [3/3]

path new OA Property(property:"data", type:"array", items:new OA\Items(properties:[new OA\Property(property:"setting_key", type:"string", example:"site_name"), new OA\Property(property:"setting_value", type:"string", example:"My Website")]))])) new OA Response(response:500, description:"Settings model could not be loaded", content:new OA\JsonContent(properties:[new OA\Property(property:"status", type:"string", example:"error"), new OA\Property(property:"message", type:"string", example:"Das Settings-Modell konnte nicht geladen werden.")]))])] public getSettings new OA App::Controllers::Api::AdminSettings::type

protected

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

app/Controllers/Api/AdminSettings.php

Geschützte Methoden

Geschützte Attribute

Ausführliche Beschreibung

Dokumentation der Elementfunktionen

◆ Property()

Dokumentation der Datenelemente

◆ $format

◆ $modelName

◆ __pad0__

◆ content [1/3]

◆ content [2/3]

◆ content [3/3]

◆ description [1/2]

◆ description [2/2]

◆ example [1/3]

◆ example [2/3]

◆ example [3/3]

◆ path

◆ requestBody

◆ responses [1/2]

◆ responses [2/2]

◆ summary [1/2]

◆ summary [2/2]

◆ tags [1/2]

◆ tags [2/2]

◆ type [1/3]

◆ type [2/3]

◆ type [3/3]

◆ pad0