Menu

## BaseApiController extends Pionia
in package

AbstractYes
BaseApiController.php : 19

This is the base controller class for the framework and most probably the only controller class that should be extended.

It is used to define the base controller for the project. According to this framework, only controller classes should be used in the entire app. That's why it is called a controller anyway! Therefore, one class in the entire should extend this class. and provide the implementation as per the project requirements.

It should call the main switch's processService method to process the request and return the response.

##### Tags

author

  Jet - ezrajet9@gmail.com

### Table of Contents

#### Properties

$name : string
$settings : array<string|int, mixed>|null
$version : string

#### Methods

__construct() : mixed
boot() : Pionia
getServerSettings() : array<string|int, mixed>
getSetting() : mixed
  Checks for the setting and returns it If the setting is not found, it returns null
getSettingOrDefault() : mixed
getSettings() : array<string|int, mixed>|null
getUploadSettings() : array<string|int, mixed>
ping() : BaseResponse
  This is just for checking the server status
resolveSettingsFromIni() : mixed

### Properties

#### $name

Pionia.php : 23
`public static string $name = 'Pionia'`

#### $settings

BaseApiController.php : 21
`public static array<string|int, mixed>|null $settings = null`

#### $version

Pionia.php : 21
`public static string $version = '1.1.5'`

### Methods

#### __construct()

BaseApiController.php : 23
`public __construct() : mixed`

#### boot()

Pionia.php : 25
`public static boot() : Pionia`

##### Return values

Pionia

#### getServerSettings()

Pionia.php : 67
`public static getServerSettings() : array<string|int, mixed>`

##### Return values

array<string|int, mixed>

#### getSetting()

Pionia.php : 55

Checks for the setting and returns it If the setting is not found, it returns null

`public static getSetting(string $key) : mixed`

Here `SERVER` and `server` are the same

##### Parameters

$key : string

#### getSettingOrDefault()

Pionia.php : 76
`public static getSettingOrDefault(string $key, mixed $default) : mixed`

##### Parameters

$key : string
$default : mixed

#### getSettings()

Pionia.php : 42
`public static getSettings() : array<string|int, mixed>|null`

##### Return values

array<string|int, mixed>|null

#### getUploadSettings()

Pionia.php : 106
`public static getUploadSettings() : array<string|int, mixed>`

##### Return values

array<string|int, mixed>

#### ping()

BaseApiController.php : 34

This is just for checking the server status

`public ping(Request $request) : BaseResponse`

##### Parameters

$request : Request

##### Return values

BaseResponse

#### resolveSettingsFromIni()

Pionia.php : 81
`public static resolveSettingsFromIni() : mixed`

## Search results