kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-12 15:35:15 +00:00
Code Issues Projects Releases Wiki Activity

Code cleanup

Browse Source
This commit is contained in:
James Cole
2021-03-21 09:15:40 +01:00
parent da1751940e
commit 206845575c
317 changed files with 7418 additions and 7362 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
app/Support/Request/AppendsLocationData.php
View File

@@ -30,41 +30,6 @@ use Log;
*/
trait AppendsLocationData
{
/**
* Abstract method stolen from "InteractsWithInput".
*
* @param null $key
* @param bool $default
*
* @return mixed
*/
abstract public function boolean($key = null, $default = false);
/**
* Abstract method.
*
* @param $key
*
* @return bool
*/
abstract public function has($key);
/**
* Abstract method.
*
* @return string
*/
abstract public function method();
/**
* Abstract method.
*
* @param mixed ...$patterns
*
* @return mixed
*/
abstract public function routeIs(...$patterns);
/**
* Read the submitted Request data and add new or updated Location data to the array.
*
@@ -125,15 +90,6 @@ trait AppendsLocationData
return $data;
}
/**
* Abstract method to ensure filling later.
*
* @param string $field
*
* @return string|null
*/
abstract protected function nullableString(string $field): ?string;
/**
* @param string|null $prefix
* @param string $key
@@ -192,6 +148,41 @@ trait AppendsLocationData
return false;
}
/**
* Abstract method stolen from "InteractsWithInput".
*
* @param null $key
* @param bool $default
*
* @return mixed
*/
abstract public function boolean($key = null, $default = false);
/**
* Abstract method.
*
* @param $key
*
* @return bool
*/
abstract public function has($key);
/**
* Abstract method.
*
* @return string
*/
abstract public function method();
/**
* Abstract method.
*
* @param mixed ...$patterns
*
* @return mixed
*/
abstract public function routeIs(...$patterns);
/**
* @param string|null $prefix
*
@@ -199,18 +190,19 @@ trait AppendsLocationData
*/
private function isValidPUT(?string $prefix): bool
{
$longitudeKey = $this->getLocationKey($prefix, 'longitude');
$latitudeKey = $this->getLocationKey($prefix, 'latitude');
$zoomLevelKey = $this->getLocationKey($prefix, 'zoom_level');
$longitudeKey = $this->getLocationKey($prefix, 'longitude');
$latitudeKey = $this->getLocationKey($prefix, 'latitude');
$zoomLevelKey = $this->getLocationKey($prefix, 'zoom_level');
$hasLocationKey = $this->getLocationKey($prefix, 'has_location');
Log::debug('Now in isValidPUT()');
// all fields must be set:
if( null !== $this->get($longitudeKey) && null !== $this->get($latitudeKey) && null !== $this->get($zoomLevelKey)) {
if (null !== $this->get($longitudeKey) && null !== $this->get($latitudeKey) && null !== $this->get($zoomLevelKey)) {
Log::debug('All fields present.');
// must be PUT and API route:
if ('PUT' === $this->method() && $this->routeIs('api.v1.*')) {
Log::debug('Is API location');
return true;
}
// if POST and not API route, must also have "has_location"
@@ -257,4 +249,13 @@ trait AppendsLocationData
}
/**
* Abstract method to ensure filling later.
*
* @param string $field
*
* @return string|null
*/
abstract protected function nullableString(string $field): ?string;
}

219
app/Support/Request/ConvertsDataTypes.php
View File

@@ -33,46 +33,6 @@ use Log;
trait ConvertsDataTypes
{
/**
* Returns all data in the request, or omits the field if not set,
* according to the config from the request. This is the way.
*
* @param array $fields
*
* @return array
*/
protected function getAllData(array $fields): array
{
$return = [];
foreach ($fields as $field => $info) {
if ($this->has($info[0])) {
$method = $info[1];
$return[$field] = $this->$method($info[0]);
}
}
return $return;
}
/**
* Return date or NULL.
*
* @param string $field
*
* @return Carbon|null
*/
protected function date(string $field): ?Carbon
{
$result = null;
try {
$result = $this->get($field) ? new Carbon($this->get($field)) : null;
} catch (Exception $e) {
Log::debug(sprintf('Exception when parsing date. Not interesting: %s', $e->getMessage()));
}
return $result;
}
/**
* Return integer value.
*
@@ -85,41 +45,28 @@ trait ConvertsDataTypes
return (int)$this->get($field);
}
/**
* Return floating value.
* Return string value, but keep newlines.
*
* @param string $field
*
* @return float|null
* @return string
*/
protected function float(string $field): ?float
public function nlString(string $field): string
{
$res = $this->get($field);
if (null === $res) {
return null;
}
return (float)$res;
return app('steam')->nlCleanString((string)($this->get($field) ?? ''));
}
/**
* Parse and clean a string, but keep the newlines.
* Return string value.
*
* @param string|null $string
* @param string $field
*
* @return string|null
* @return string
*/
protected function nlStringFromValue(?string $string): ?string
public function string(string $field): string
{
if (null === $string) {
return null;
}
$result = app('steam')->nlCleanString($string);
return '' === $result ? null : $result;
return app('steam')->cleanString((string)($this->get($field) ?? ''));
}
/**
@@ -142,6 +89,56 @@ trait ConvertsDataTypes
return null;
}
/**
* @param string $value
*
* @return bool
*/
protected function convertBoolean(?string $value): bool
{
if (null === $value) {
return false;
}
if ('' === $value) {
return false;
}
if ('true' === $value) {
return true;
}
if ('yes' === $value) {
return true;
}
if (1 === $value) {
return true;
}
if ('1' === $value) {
return true;
}
if (true === $value) {
return true;
}
return false;
}
/**
* Return date or NULL.
*
* @param string $field
*
* @return Carbon|null
*/
protected function date(string $field): ?Carbon
{
$result = null;
try {
$result = $this->get($field) ? new Carbon($this->get($field)) : null;
} catch (Exception $e) {
Log::debug(sprintf('Exception when parsing date. Not interesting: %s', $e->getMessage()));
}
return $result;
}
/**
* @param string|null $string
@@ -169,22 +166,42 @@ trait ConvertsDataTypes
}
/**
* Parse and clean a string.
* Return floating value.
*
* @param string|null $string
* @param string $field
*
* @return string|null
* @return float|null
*/
protected function stringFromValue(?string $string): ?string
protected function float(string $field): ?float
{
if (null === $string) {
$res = $this->get($field);
if (null === $res) {
return null;
}
$result = app('steam')->cleanString($string);
return '' === $result ? null : $result;
return (float)$res;
}
/**
* Returns all data in the request, or omits the field if not set,
* according to the config from the request. This is the way.
*
* @param array $fields
*
* @return array
*/
protected function getAllData(array $fields): array
{
$return = [];
foreach ($fields as $field => $info) {
if ($this->has($info[0])) {
$method = $info[1];
$return[$field] = $this->$method($info[0]);
}
}
return $return;
}
/**
* Parse to integer
@@ -206,15 +223,21 @@ trait ConvertsDataTypes
}
/**
* Return string value, but keep newlines.
* Parse and clean a string, but keep the newlines.
*
* @param string $field
* @param string|null $string
*
* @return string
* @return string|null
*/
public function nlString(string $field): string
protected function nlStringFromValue(?string $string): ?string
{
return app('steam')->nlCleanString((string)($this->get($field) ?? ''));
if (null === $string) {
return null;
}
$result = app('steam')->nlCleanString($string);
return '' === $result ? null : $result;
}
/**
@@ -254,39 +277,6 @@ trait ConvertsDataTypes
return app('steam')->nlCleanString((string)($this->get($field) ?? ''));
}
/**
* @param string $value
*
* @return bool
*/
protected function convertBoolean(?string $value): bool
{
if (null === $value) {
return false;
}
if ('' === $value) {
return false;
}
if ('true' === $value) {
return true;
}
if ('yes' === $value) {
return true;
}
if (1 === $value) {
return true;
}
if ('1' === $value) {
return true;
}
if (true === $value) {
return true;
}
return false;
}
/**
* Return string value, or NULL if empty.
*
@@ -308,14 +298,19 @@ trait ConvertsDataTypes
}
/**
* Return string value.
* Parse and clean a string.
*
* @param string $field
* @param string|null $string
*
* @return string
* @return string|null
*/
public function string(string $field): string
protected function stringFromValue(?string $string): ?string
{
return app('steam')->cleanString((string)($this->get($field) ?? ''));
if (null === $string) {
return null;
}
$result = app('steam')->cleanString($string);
return '' === $result ? null : $result;
}
}

1
app/Support/Request/GetRuleConfiguration.php
View File

@@ -69,6 +69,7 @@ trait GetRuleConfiguration
$return[] = $key;
}
}
return $return;
}
}