Skip to content

Add request custom methods #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 18, 2022
Merged

Add request custom methods #92

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0afdc1
Add request custom methods
rawahamid Oct 11, 2022
4b821bf
Spell check done
rawahamid Oct 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions src/LaravelRequestDocs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ public function appendRequestRules(array $controllersInfo)
$reflectionMethod = new ReflectionMethod($controller, $method);
$params = $reflectionMethod->getParameters();
$customRules = $this->customParamsDocComment($reflectionMethod->getDocComment());
$controllersInfo[$index]['rules'] = [];

foreach ($params as $param) {
if (!$param->getType()) {
Expand All @@ -133,18 +134,16 @@ public function appendRequestRules(array $controllersInfo)
//throw $th;
}

if ($requestClass && method_exists($requestClass, 'rules')) {
try {
$controllersInfo[$index]['rules'] = $this->flattenRules($requestClass->rules());
} catch (Throwable $e) {
// disabled. This only works when the rules are defined as 'required|integer' and that too in single line
// doesn't work well when the same rule is defined as array ['required', 'integer'] or in multiple lines such as
// If your rules are not populated using this library, then fix your rule to only throw validation errors and not throw exceptions
// such as 404, 500 inside the request class.
$controllersInfo[$index]['rules'] = $this->rulesByRegex($requestClassName);
foreach (config('request-docs.request_methods') as $requestMethod) {
if ($requestClass && method_exists($requestClass, $requestMethod)) {
try {
$controllersInfo[$index]['rules'] = array_merge($controllersInfo[$index]['rules'], $this->flattenRules($requestClass->$requestMethod()));

if (config('request-docs.debug')) {
throw $e;
} catch (Throwable $e) {
$controllersInfo[$index]['rules'] = array_merge($controllersInfo[$index]['rules'], $this->rulesByRegex($requestClassName, $requestMethod));
if (config('request-docs.debug')) {
throw $e;
}
}
}
}
Expand Down Expand Up @@ -211,9 +210,9 @@ public function flattenRules($mixedRules)
return $rules;
}

public function rulesByRegex($requestClassName)
public function rulesByRegex($requestClassName, $methodName)
{
$data = new ReflectionMethod($requestClassName, 'rules');
$data = new ReflectionMethod($requestClassName, $methodName);
$lines = file($data->getFileName());
$rules = [];

Expand Down