Inspired by a Twitter thread, this is a stab at making Form Request data transfer objects. This package is currently WIP.
To create your request with validation rules, simply extend AnterisDev\FormRequest\FormRequestData and add your public properties. To specify the validation rules for a property, pass a string of Laravel validation rules to the AnterisDev\FormRequest\Attributes\Validation attribute.
Note: This package intelligently adds rules like "required" when a property is not nullable and handles adding rules for default PHP types such as "string" for properties that are type hinted as a
string.
For example:
use AnterisDev\FormRequest\Attributes\Validation;
use AnterisDev\FormRequest\FormRequestData;
class CreatePersonRequest extends FormRequestData
{
#[Validation('required', 'string', 'max:255')]
public string $first_name;
#[Validation('required|string|max:255')]
public string $last_name;
// This property is still required because it is not nullable.
// This property will also be validated as a string since it has that type.
#[Validation('max:255')]
public string $email;
}Then specify this request in your controller method:
public function store(CreatePersonRequest $request)
{
die('Hello ' . $request->first_name . ' ' . $request->last_name);
}Based on the type of the property, the following rules get applied automatically:
requiredwhen the property does not accept a null vallue and doesn't have a default valuenullablewhen the property does accept a null value or has a default valuestringintnumericfor floatarrayboolean
For example, the following snippet:
class ContactInformation extends FormRequestData
{
public string $email;
//generates ['sometimes', 'string'];
public ?string $first_name = null;
//generates ['sometimes', 'nullable', 'string']
public ?string $last_name;
//generates ['sometimes', 'nullable', 'string']
public string $role = 'user';
//generates ['sometimes', 'string']
}You can add any valid Laravel rules via the Validation attributes.
Provide the validation rules as a string parameter to to the Validation object,
multiple parameters can be passed as multiple arguments
For example, the following snippet:
class CreateUser extends FormRequestData
{
#[Required, Validation('email')]
public string $email;
//generates ['required', 'string', 'email'];
#[Required, Validation('min:1', 'max:20')]
public string $username;
//generates ['required', 'string', 'min:1', 'max:20']
#[Required, Validation('password')]
public string $password;
//generates ['required', 'string', 'password]
}Most validation rules are wrapped in predefined attributes. For example, the following snippet:
class CreateUser extends FormRequestData
{
#[Email]
public string $email;
//generates ['sometimes', 'string', 'email'];
#[Min(1), Max(20)]
public string $username;
//generates ['sometimes', 'nullable', 'string', 'min:1', 'max:20']
#[Password]
public string $password;
//generates ['sometimes', 'required', 'string', 'password]
}You can list multiple validation rules
#[Email, Validate('min:1')]
public string $email;
//generates ['sometimes', 'string', 'email', 'min:1];You can list multiple validation rules
#[Attribute(Attribute::TARGET_PROPERTY)]
class CreativePasswordValidationn implements Rule
{
public function getRules(): array
{
return [
'regex:/^.*(?=.{3,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[\d\x])(?=.*[!$#%]).*$/'
];
}
}#[CreativePasswordValidation]
public string $password;
//generates ['sometimes', 'string', 'regex:/^.*(?=.{3,})(?=.*[a-zA-Z])(?=.*[0-9])(?=.*[\d\x])(?=.*[!$#%]).*$/'];class CreateUser extends FormRequestData
{
#[Required]
public string $first_name;
//generates ['required', 'string''];
#[Required, ValidateArray('string', 'email')]
public array $list;
/*generates [
'list' => 'required'
'list' => 'array'
'list.*' => 'string|email|max:255'
];
*/
}class CreateUser extends FormRequestData
{
#[Required]
public string $first_name;
//generates ['required', 'string''];
#[ValidationFor('street', 'required', 'string'), ValidationFor('city', 'required', 'string')]
public object $address;
/*generates [
'address.street' => 'required', 'string'
];
*/
}You can nest FormRequestData objects:
class CreateUser extends FormRequestData
{
#[Required]
public string $first_name;
//generates ['required', 'string''];
public CreateAddress $address;
/*generates [
'address.street' => 'required', 'string',
'address.city' => 'required', 'string',
'address.country_id' => 'required', 'string', 'uuid', 'exists:countries,id'
];
*/
}
class CreateAddress extends FormRequestData
{
#[Required]
public string $street;
//generates ['required', 'string'];
#[Required]
public string $city;
//generates ['required', 'string']
#[Required, Uuid, Exists('countries', 'id')]
public string $country_id;
//generates ['required', 'string', 'uuid', 'exists:countries,id']
}You can nest array of FormRequestData objects:
class ContactList extends FormRequestData
{
#[Required]
public string $name;
//generates ['required', 'string'];
/** @var array<CreateContact> */
#[ArrayOf(CreateContact::class)]
public array $contacts;
/*generates [
'contacts.*.first_name' => 'required', 'string',
];
*/
}
class CreateContact extends FormRequestData
{
#[Required]
public string $first_name;
//generates ['required', 'string''];
}Due to several options available to the Email validator, the Email validation attribute accepts several flags. These are:
Email::RfcValidationEmail::NoRfcWarningsValidationEmail::DnsCheckValidationEmail::SpoofCheckValidationEmail:FilterEmailValidation
By default, the mode is set to Email::RfcValidation.
See an example of this usage below:
class ContactInformation extends FormRequestData
{
#[Required, Email]
public string $email;
#[Required, Email(Email::DnsCheckValidation | Email::SpoofCheckValidation)]
public string $email_2;
}To assist with building your validation rules, various attributes are available. These attributes have typed parameters so that it is easy to see their available options.
The following attributes currently exist:
Anteris\FormRequest\Attributes\AcceptedAnteris\FormRequest\Attributes\AcceptedIfAnteris\FormRequest\Attributes\ActiveUrlAnteris\FormRequest\Attributes\AfterAnteris\FormRequest\Attributes\AfterOrEqualAnteris\FormRequest\Attributes\AlphaAnteris\FormRequest\Attributes\AlphaNumericAnteris\FormRequest\Attributes\AlphaNumericDashAnteris\FormRequest\Attributes\BailAnteris\FormRequest\Attributes\BeforeAnteris\FormRequest\Attributes\BeforeOrEqualAnteris\FormRequest\Attributes\BetweenAnteris\FormRequest\Attributes\BooleanAnteris\FormRequest\Attributes\ConfirmedAnteris\FormRequest\Attributes\CurrentPasswordAnteris\FormRequest\Attributes\DateAnteris\FormRequest\Attributes\DateEqualsAnteris\FormRequest\Attributes\DateFormatAnteris\FormRequest\Attributes\DifferentAnteris\FormRequest\Attributes\DigitsAnteris\FormRequest\Attributes\DigitsBetweenAnteris\FormRequest\Attributes\DimensionsAnteris\FormRequest\Attributes\EmailAnteris\FormRequest\Attributes\EndsWithAnteris\FormRequest\Attributes\ExcludeIfAnteris\FormRequest\Attributes\ExcludeUnlessAnteris\FormRequest\Attributes\ExistsAnteris\FormRequest\Attributes\FileAnteris\FormRequest\Attributes\FilledAnteris\FormRequest\Attributes\GreaterThanAnteris\FormRequest\Attributes\GreaterThanOrEqualToAnteris\FormRequest\Attributes\ImageAnteris\FormRequest\Attributes\InAnteris\FormRequest\Attributes\IntegerAnteris\FormRequest\Attributes\IPAnteris\FormRequest\Attributes\IPv4Anteris\FormRequest\Attributes\IPv6Anteris\FormRequest\Attributes\JsonAnteris\FormRequest\Attributes\LessThanAnteris\FormRequest\Attributes\LessThanOrEqualToAnteris\FormRequest\Attributes\MaxAnteris\FormRequest\Attributes\MimesAnteris\FormRequest\Attributes\MimeTypesAnteris\FormRequest\Attributes\MinAnteris\FormRequest\Attributes\MultipleOfAnteris\FormRequest\Attributes\NotInAnteris\FormRequest\Attributes\NotRegexAnteris\FormRequest\Attributes\NullableAnteris\FormRequest\Attributes\NumericAnteris\FormRequest\Attributes\PasswordAnteris\FormRequest\Attributes\PasswordDefaultsAnteris\FormRequest\Attributes\PresentAnteris\FormRequest\Attributes\ProhibitedAnteris\FormRequest\Attributes\ProhibitedIfAnteris\FormRequest\Attributes\ProhibitedUnlessAnteris\FormRequest\Attributes\RegexAnteris\FormRequest\Attributes\RequiredAnteris\FormRequest\Attributes\RequiredIfAnteris\FormRequest\Attributes\RequiredUnlessAnteris\FormRequest\Attributes\RequiredWithAnteris\FormRequest\Attributes\RequiredWithAllAnteris\FormRequest\Attributes\RequiredWithoutAnteris\FormRequest\Attributes\RequiredWithoutAllAnteris\FormRequest\Attributes\SameAnteris\FormRequest\Attributes\SizeAnteris\FormRequest\Attributes\StartsWithAnteris\FormRequest\Attributes\TimezoneAnteris\FormRequest\Attributes\UrlAnteris\FormRequest\Attributes\Uuid
To create your own validation attribute, simply extend Anteris\FormRequest\Attributes\Rule and provide the correct output to the getRules() method.