web-base/core/Api/Parameter/Parameter.class.php

204 lines
5.9 KiB
PHP
Raw Normal View History

2020-02-09 23:02:19 +01:00
<?php
namespace Api\Parameter;
2020-04-03 15:56:04 +02:00
use DateTime;
2020-02-09 23:02:19 +01:00
class Parameter {
const TYPE_INT = 0;
const TYPE_FLOAT = 1;
const TYPE_BOOLEAN = 2;
const TYPE_STRING = 3;
const TYPE_DATE = 4;
const TYPE_TIME = 5;
const TYPE_DATE_TIME = 6;
const TYPE_EMAIL = 7;
// only internal access
const TYPE_RAW = 8;
2020-06-19 16:37:44 +02:00
2022-02-20 16:53:26 +01:00
// only json will work here I guess
2021-01-12 15:49:41 +01:00
// nope. also name[]=value
2020-02-09 23:02:19 +01:00
const TYPE_ARRAY = 9;
2021-01-12 15:49:41 +01:00
const TYPE_MIXED = 10;
2020-02-09 23:02:19 +01:00
2021-01-12 15:49:41 +01:00
const names = array('Integer', 'Float', 'Boolean', 'String', 'Date', 'Time', 'DateTime', 'E-Mail', 'Raw', 'Array', 'Mixed');
2020-02-09 23:02:19 +01:00
2022-02-20 16:53:26 +01:00
const DATE_FORMAT = "Y-m-d";
const TIME_FORMAT = "H:i:s";
const DATE_TIME_FORMAT = self::DATE_FORMAT . " " . self::TIME_FORMAT;
private $defaultValue;
2020-04-03 15:56:04 +02:00
public string $name;
2020-02-09 23:02:19 +01:00
public $value;
2021-04-02 21:58:06 +02:00
public bool $optional;
2020-04-03 15:56:04 +02:00
public int $type;
public string $typeName;
2020-02-09 23:02:19 +01:00
2021-04-02 21:58:06 +02:00
public function __construct(string $name, int $type, bool $optional = FALSE, $defaultValue = NULL) {
2020-02-09 23:02:19 +01:00
$this->name = $name;
$this->optional = $optional;
2022-02-20 16:53:26 +01:00
$this->defaultValue = $defaultValue;
2020-02-09 23:02:19 +01:00
$this->value = $defaultValue;
$this->type = $type;
$this->typeName = $this->getTypeName();
}
2022-02-20 16:53:26 +01:00
public function reset() {
$this->value = $this->defaultValue;
}
public function getSwaggerTypeName(): string {
$typeName = strtolower(($this->type >= 0 && $this->type < count(Parameter::names)) ? Parameter::names[$this->type] : "invalid");
if ($typeName === "mixed" || $typeName === "raw") {
return "object";
}
if (!in_array($typeName, ["array", "boolean", "integer", "number", "object", "string"])) {
return "string";
}
return $typeName;
}
public function getSwaggerFormat(): ?string {
switch ($this->type) {
case self::TYPE_DATE:
return self::DATE_FORMAT;
case self::TYPE_TIME:
return self::TIME_FORMAT;
case self::TYPE_DATE_TIME:
return self::DATE_TIME_FORMAT;
case self::TYPE_EMAIL:
return "email";
default:
return null;
}
}
2021-04-02 21:58:06 +02:00
public function getTypeName(): string {
2020-02-09 23:02:19 +01:00
return ($this->type >= 0 && $this->type < count(Parameter::names)) ? Parameter::names[$this->type] : "INVALID";
}
2021-04-02 21:58:06 +02:00
public function toString(): string {
2020-02-09 23:02:19 +01:00
$typeName = Parameter::names[$this->type];
$str = "$typeName $this->name";
$defaultValue = (is_null($this->value) ? 'NULL' : $this->value);
if($this->optional) {
$str = "[$str = $defaultValue]";
}
return $str;
}
2021-04-02 21:58:06 +02:00
public static function parseType($value): int {
2020-02-09 23:02:19 +01:00
if(is_array($value))
return Parameter::TYPE_ARRAY;
else if(is_numeric($value) && intval($value) == $value)
return Parameter::TYPE_INT;
else if(is_float($value) || (is_numeric($value) && floatval($value) == $value))
return Parameter::TYPE_FLOAT;
else if(is_bool($value) || $value == "true" || $value == "false")
return Parameter::TYPE_BOOLEAN;
else if(is_a($value, 'DateTime'))
return Parameter::TYPE_DATE_TIME;
2022-02-20 18:31:54 +01:00
else if($value !== null && ($d = DateTime::createFromFormat(self::DATE_FORMAT, $value)) && $d->format(self::DATE_FORMAT) === $value)
2020-02-09 23:02:19 +01:00
return Parameter::TYPE_DATE;
2022-02-20 18:31:54 +01:00
else if($value !== null && ($d = DateTime::createFromFormat(self::TIME_FORMAT, $value)) && $d->format(self::TIME_FORMAT) === $value)
2020-02-09 23:02:19 +01:00
return Parameter::TYPE_TIME;
2022-02-20 18:31:54 +01:00
else if($value !== null && ($d = DateTime::createFromFormat(self::DATE_TIME_FORMAT, $value)) && $d->format(self::DATE_TIME_FORMAT) === $value)
2020-02-09 23:02:19 +01:00
return Parameter::TYPE_DATE_TIME;
else if (filter_var($value, FILTER_VALIDATE_EMAIL))
return Parameter::TYPE_EMAIL;
else
return Parameter::TYPE_STRING;
}
2021-04-02 21:58:06 +02:00
public function parseParam($value): bool {
2020-02-09 23:02:19 +01:00
switch($this->type) {
case Parameter::TYPE_INT:
if(is_numeric($value) && intval($value) == $value) {
$this->value = intval($value);
return true;
}
return false;
case Parameter::TYPE_FLOAT:
if(is_numeric($value) && (floatval($value) == $value || intval($value) == $value)) {
$this->value = floatval($value);
return true;
}
return false;
case Parameter::TYPE_BOOLEAN:
if(strcasecmp($value, 'true') === 0)
$this->value = true;
else if(strcasecmp($value, 'false') === 0)
$this->value = false;
else if(is_bool($value))
$this->value = (bool)$value;
else
return false;
return true;
case Parameter::TYPE_DATE:
if(is_a($value, "DateTime")) {
$this->value = $value;
return true;
}
2022-02-20 16:53:26 +01:00
$d = DateTime::createFromFormat(self::DATE_FORMAT, $value);
if($d && $d->format(self::DATE_FORMAT) === $value) {
2020-02-09 23:02:19 +01:00
$this->value = $d;
return true;
}
return false;
case Parameter::TYPE_TIME:
if(is_a($value, "DateTime")) {
$this->value = $value;
return true;
}
2022-02-20 16:53:26 +01:00
$d = DateTime::createFromFormat(self::TIME_FORMAT, $value);
if($d && $d->format(self::TIME_FORMAT) === $value) {
2020-02-09 23:02:19 +01:00
$this->value = $d;
return true;
}
return false;
case Parameter::TYPE_DATE_TIME:
if(is_a($value, 'DateTime')) {
$this->value = $value;
return true;
} else {
2022-02-20 16:53:26 +01:00
$d = DateTime::createFromFormat(self::DATE_TIME_FORMAT, $value);
if($d && $d->format(self::DATE_TIME_FORMAT) === $value) {
2020-02-09 23:02:19 +01:00
$this->value = $d;
return true;
}
}
return false;
case Parameter::TYPE_EMAIL:
if (filter_var($value, FILTER_VALIDATE_EMAIL)) {
$this->value = $value;
return true;
}
return false;
case Parameter::TYPE_ARRAY:
if(is_array($value)) {
$this->value = $value;
return true;
}
return false;
default:
$this->value = $value;
return true;
}
}
2020-04-03 15:56:04 +02:00
}