DRCIT/snipe-it
1
0
Fork 0
mirror of https://github.com/snipe/snipe-it.git synced 2025-03-05 20:52:15 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add docblocks

Browse source
This commit is contained in:
Marcus Moore 2024-01-18 15:42:52 -08:00
parent 1630392953
commit b74115b604
No known key found for this signature in database
2 changed files with 56 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
app/Models/ReportTemplate.php
View file

@ -43,11 +43,24 @@ class ReportTemplate extends Model
}); });
} }
/**
* Establishes the report template -> creator relationship.
*
* @since [v6.2.4]
*/
public function user(): BelongsTo public function user(): BelongsTo
{ {
return $this->belongsTo(User::class); return $this->belongsTo(User::class);
} }
/**
* Get the value of a checkbox field for the given field name.
*
* @param string $fieldName
* @param string $fallbackValue The value to return if the report template is not saved yet.
*
* @since [v6.2.4]
*/
public function checkmarkValue(string $fieldName, string $fallbackValue = '1'): string public function checkmarkValue(string $fieldName, string $fallbackValue = '1'): string
{ {
// Assuming we're using the null object pattern, and an empty model // Assuming we're using the null object pattern, and an empty model
@ -62,6 +75,15 @@ class ReportTemplate extends Model
return $this->options[$fieldName] ?? '0'; return $this->options[$fieldName] ?? '0';
} }
/**
* Get the value of a radio field for the given field name.
*
* @param string $fieldName
* @param string $value The value to check against.
* @param bool $isDefault Whether the radio input being checked is the default.
*
* @since [v6.2.4]
*/
public function radioValue(string $fieldName, string $value, bool $isDefault = false): bool public function radioValue(string $fieldName, string $value, bool $isDefault = false): bool
{ {
$fieldExists = array_has($this->options, $fieldName); $fieldExists = array_has($this->options, $fieldName);
@ -81,6 +103,16 @@ class ReportTemplate extends Model
return false; return false;
} }
/**
* Get the value of a select field for the given field name.
*
* @param string $fieldName
* @param string|null $model The Eloquent model to check against.
*
* @return mixed|null
*
* @since [v6.2.4]
*/
public function selectValue(string $fieldName, string $model = null) public function selectValue(string $fieldName, string $model = null)
{ {
// If the field does not exist then return null. // If the field does not exist then return null.
@ -109,6 +141,16 @@ class ReportTemplate extends Model
return $value; return $value;
} }
/**
* Get the values of a multi-select field for the given field name.
*
* @param string $fieldName
* @param string|null $model The Eloquent model to check against.
*
* @return iterable
*
* @since [v6.2.4]
*/
public function selectValues(string $fieldName, string $model = null): iterable public function selectValues(string $fieldName, string $model = null): iterable
{ {
// If the field does not exist then return an empty array. // If the field does not exist then return an empty array.
@ -132,6 +174,15 @@ class ReportTemplate extends Model
return $this->options[$fieldName]; return $this->options[$fieldName];
} }
/**
* Get the value of a text field for the given field name.
*
* @param string $fieldName
*
* @return string
*
* @since [v6.2.4]
*/
public function textValue(string $fieldName): string public function textValue(string $fieldName): string
{ {
// Assuming we're using the null object pattern, // Assuming we're using the null object pattern,

5
app/Models/User.php
View file

@ -330,6 +330,11 @@ class User extends SnipeModel implements AuthenticatableContract, AuthorizableCo
return $this->belongsToMany(\App\Models\License::class, 'license_seats', 'assigned_to', 'license_id')->withPivot('id'); return $this->belongsToMany(\App\Models\License::class, 'license_seats', 'assigned_to', 'license_id')->withPivot('id');
} }
/**
* Establishes the user -> reportTemplates relationship
*
* @since [v6.2.4]
*/
public function reportTemplates(): HasMany public function reportTemplates(): HasMany
{ {
return $this->hasMany(ReportTemplate::class); return $this->hasMany(ReportTemplate::class);