ldc-enum/src/BaseEnumRoutable.php

86 lines
2.3 KiB
PHP
Raw Normal View History

<?php
namespace Kwaadpepper\Enum;
use BadMethodCallException;
use Illuminate\Contracts\Routing\UrlRoutable;
use Kwaadpepper\Enum\Exceptions\NotImplementedException;
2021-09-11 11:11:21 +02:00
/**
* This Base Enum will be routable with laravel.
* So you can use it with service container passing an
* enumeration as any route parameter directly as
* a controller parameter.
*/
abstract class BaseEnumRoutable extends BaseEnum implements UrlRoutable
{
/**
* Get the value of the model's route key.
*
* @return mixed
*/
public function getRouteKey()
{
return $this->value;
}
/**
* Get the route key for the model.
*
* @return string
*/
public function getRouteKeyName()
{
throw new NotImplementedException('getRouteKeyName not implemented, should not be used');
}
/**
* Retrieve the model for a bound value.
*
* @param mixed $value
* @param string|null $field
2021-09-11 13:35:17 +02:00
* @return \Kwaadpepper\Enum\BaseEnum|null
*/
2021-09-11 11:11:21 +02:00
// phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassAfterLastUsed
public function resolveRouteBinding($value, $field = null)
{
// try to cast numeric value first
try {
return static::make(is_numeric($value) ? intval($value) : $value);
} catch (BadMethodCallException $e) {
2021-09-11 11:11:21 +02:00
// try string value after that
try {
return static::make($value);
} catch (BadMethodCallException $e) {
// could not find a suitable value
return null;
}
}
}
/**
* Retrieve the child model for a bound value.
*
* @param string $childType
* @param mixed $value
* @param string|null $field
* @return \Illuminate\Database\Eloquent\Model|null
* @throws NotImplementedException
*/
public function resolveChildRouteBinding($childType, $value, $field)
{
throw new NotImplementedException('resolveChildRouteBinding not implemented, should not be used');
}
/**
* Get the Enum name from class name
*
* @return string
*/
public static function getEnumName()
{
$cls = explode('\\', static::class);
return array_pop($cls);
}
}