Skip to content
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.

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

Testing a fix for StyleCI being trigger happy #3828

Merged
merged 2 commits into from
Sep 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
<a href="https://backpackforlaravel.com/newsletter">Newsletter</a>
</p>


Quickly build an admin interface for your Eloquent models. Then customize every little detail. Among its features:

- List operation
Expand Down
6 changes: 2 additions & 4 deletions src/BackpackServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,7 @@ public function publishFiles()
/**
* Define the routes for the application.
*
* @param \Illuminate\Routing\Router $router
*
* @param \Illuminate\Routing\Router $router
* @return void
*/
public function setupRoutes(Router $router)
Expand All @@ -161,8 +160,7 @@ public function setupRoutes(Router $router)
/**
* Load custom routes file.
*
* @param \Illuminate\Routing\Router $router
*
* @param \Illuminate\Routing\Router $router
* @return void
*/
public function setupCustomRoutes(Router $router)
Expand Down
14 changes: 6 additions & 8 deletions src/Stats.php
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,9 @@ private function sendUsageStats()
* It spins up a separate process for this, and doesn't listen for a reponse,
* so it has minimal to no impact on pageload.
*
* @param string $method HTTP Method to use for the request.
* @param string $url URL to point the request at.
* @param array $payload The data you want sent to the URL.
*
* @param string $method HTTP Method to use for the request.
* @param string $url URL to point the request at.
* @param array $payload The data you want sent to the URL.
* @return void
*/
private function makeCurlRequest($method, $url, $payload)
Expand All @@ -107,10 +106,9 @@ private function makeCurlRequest($method, $url, $payload)
* geographic location this is usually slower than CURL. However,
* unlike CURL, it works on most machines, so it's reliable.
*
* @param string $method HTTP Method to use for the request.
* @param string $url URL to point the request at.
* @param array $payload The data you want sent to the URL.
*
* @param string $method HTTP Method to use for the request.
* @param string $url URL to point the request at.
* @param array $payload The data you want sent to the URL.
* @return void
*/
private function makeGuzzleRequest($method, $url, $payload)
Expand Down
6 changes: 3 additions & 3 deletions src/app/Console/Commands/AddCustomRouteContent.php
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ private function customRoutesFileEndLine($file_lines)
/**
* Parse the given file stream and return the line number where a string is found.
*
* @param string $needle The string that's being searched for.
* @param array $haystack The file where the search is being performed.
* @return bool|int The last line number where the string was found. Or false.
* @param string $needle The string that's being searched for.
* @param array $haystack The file where the search is being performed.
* @return bool|int The last line number where the string was found. Or false.
*/
private function getLastLineNumberThatContains($needle, $haystack)
{
Expand Down
6 changes: 3 additions & 3 deletions src/app/Console/Commands/AddSidebarContent.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ public function handle()
/**
* Parse the given file stream and return the line number where a string is found.
*
* @param string $needle The string that's being searched for.
* @param array $haystack The file where the search is being performed.
* @return bool|int The last line number where the string was found. Or false.
* @param string $needle The string that's being searched for.
* @param array $haystack The file where the search is being performed.
* @return bool|int The last line number where the string was found. Or false.
*/
private function getLastLineNumberThatContains($needle, $haystack)
{
Expand Down
8 changes: 3 additions & 5 deletions src/app/Console/Commands/PublishBackpackMiddleware.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ public function handle()
/**
* Build the class. Replace Backpack namespace with App one.
*
* @param string $name
*
* @param string $name
* @return string
*/
protected function buildClass($name = false)
Expand All @@ -70,9 +69,8 @@ protected function buildClass($name = false)
* Replace the namespace for the given stub.
* Replace the User model, if it was moved to App\Models\User.
*
* @param string $stub
* @param string $name
*
* @param string $stub
* @param string $name
* @return $this
*/
protected function makeReplacements(&$stub)
Expand Down
3 changes: 1 addition & 2 deletions src/app/Console/Commands/PublishView.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ public function handle()
/**
* Take a blade file from the vendor folder and publish it to the resources folder.
*
* @param string $file The filename without extension
*
* @param string $file The filename without extension
* @return void
*/
protected function publishFile($file)
Expand Down
20 changes: 9 additions & 11 deletions src/app/Console/Commands/Traits/PrettyCommandOutput.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,9 @@ trait PrettyCommandOutput
/**
* Run a SSH command.
*
* @param string $command The SSH command that needs to be run
* @param bool $beforeNotice Information for the user before the command is run
* @param bool $afterNotice Information for the user after the command is run
*
* @param string $command The SSH command that needs to be run
* @param bool $beforeNotice Information for the user before the command is run
* @param bool $afterNotice Information for the user after the command is run
* @return mixed Command-line output
*/
public function executeProcess($command, $beforeNotice = false, $afterNotice = false)
Expand Down Expand Up @@ -51,11 +50,10 @@ public function executeProcess($command, $beforeNotice = false, $afterNotice = f
/**
* Run an artisan command.
*
* @param string $command The artisan command to be run.
* @param array $arguments Key-value array of arguments to the artisan command.
* @param bool $beforeNotice Information for the user before the command is run
* @param bool $afterNotice Information for the user after the command is run
*
* @param string $command The artisan command to be run.
* @param array $arguments Key-value array of arguments to the artisan command.
* @param bool $beforeNotice Information for the user before the command is run
* @param bool $afterNotice Information for the user after the command is run
* @return mixed Command-line output
*/
public function executeArtisanProcess($command, $arguments = [], $beforeNotice = false, $afterNotice = false)
Expand All @@ -82,8 +80,8 @@ public function executeArtisanProcess($command, $arguments = [], $beforeNotice =
/**
* Write text to the screen for the user to see.
*
* @param string $type line, info, comment, question, error
* @param string $content
* @param string $type line, info, comment, question, error
* @param string $content
*/
public function echo($type, $content)
{
Expand Down
3 changes: 1 addition & 2 deletions src/app/Console/Commands/Version.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ public function handle()
/**
* Run a shell command in a separate process.
*
* @param string $command Text to be executed.
*
* @param string $command Text to be executed.
* @return void
*/
private function runConsoleCommand($command)
Expand Down
1 change: 0 additions & 1 deletion src/app/Exceptions/AccessDeniedException.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ class AccessDeniedException extends Exception
* Render the exception into an HTTP response.
*
* @param \Illuminate\Http\Request
*
* @return \Illuminate\Http\Response
*/
public function render($request)
Expand Down
3 changes: 1 addition & 2 deletions src/app/Http/Controllers/Auth/LoginController.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,7 @@ public function username()
/**
* The user has logged out of the application.
*
* @param \Illuminate\Http\Request $request
*
* @param \Illuminate\Http\Request $request
* @return mixed
*/
protected function loggedOut(Request $request)
Expand Down
9 changes: 3 additions & 6 deletions src/app/Http/Controllers/Auth/RegisterController.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ public function __construct()
/**
* Get a validator for an incoming registration request.
*
* @param array $data
*
* @param array $data
* @return \Illuminate\Contracts\Validation\Validator
*/
protected function validator(array $data)
Expand All @@ -64,8 +63,7 @@ protected function validator(array $data)
/**
* Create a new user instance after a valid registration.
*
* @param array $data
*
* @param array $data
* @return User
*/
protected function create(array $data)
Expand Down Expand Up @@ -100,8 +98,7 @@ public function showRegistrationForm()
/**
* Handle a registration request for the application.
*
* @param \Illuminate\Http\Request $request
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function register(Request $request)
Expand Down
8 changes: 3 additions & 5 deletions src/app/Http/Controllers/Auth/ResetPasswordController.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ class ResetPasswordController extends Controller
/**
* Get the path the user should be redirected to after password reset.
*
* @param \Illuminate\Http\Request $request
*
* @param \Illuminate\Http\Request $request
* @return string
*/
public function redirectTo()
Expand Down Expand Up @@ -64,9 +63,8 @@ public function __construct()
*
* If no token is present, display the link request form.
*
* @param \Illuminate\Http\Request $request
* @param string|null $token
*
* @param \Illuminate\Http\Request $request
* @param string|null $token
* @return \Illuminate\Http\Response
*/
public function showResetForm(Request $request, $token = null)
Expand Down
4 changes: 2 additions & 2 deletions src/app/Http/Controllers/ChartController.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public function getLibraryFilePath()
* Set the path where the chart widget will find the JS file (or files)
* needeed to set up the charting.
*
* @param string|array $path Full URL to the JS file of the charting library. Or array.
* @param string|array $path Full URL to the JS file of the charting library. Or array.
*/
protected function setLibraryFilePath($path)
{
Expand All @@ -63,7 +63,7 @@ protected function setLibraryFilePath($path)
* Because the dataset always includes the name of the charting library,
* we can use that to determine which JS file we should be loading from the CDN.
*
* @param string $dataset Class name of the dataset of the current chart.
* @param string $dataset Class name of the dataset of the current chart.
*/
protected function setLibraryFilePathFromDatasetType($dataset)
{
Expand Down
6 changes: 3 additions & 3 deletions src/app/Http/Controllers/CrudController.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ public function setup()
* Load routes for all operations.
* Allow developers to load extra routes by creating a method that looks like setupOperationNameRoutes.
*
* @param string $segment Name of the current entity (singular).
* @param string $routeName Route name prefix (ends with .).
* @param string $controller Name of the current controller.
* @param string $segment Name of the current entity (singular).
* @param string $routeName Route name prefix (ends with .).
* @param string $controller Name of the current controller.
*/
public function setupRoutes($segment, $routeName, $controller)
{
Expand Down
9 changes: 4 additions & 5 deletions src/app/Http/Controllers/Operations/BulkCloneOperation.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ trait BulkCloneOperation
/**
* Define which routes are needed for this operation.
*
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
*/
protected function setupBulkCloneRoutes($segment, $routeName, $controller)
{
Expand Down Expand Up @@ -42,8 +42,7 @@ protected function setupBulkCloneDefaults()
/**
* Create duplicates of multiple entries in the datatabase.
*
* @param int $id
*
* @param int $id
* @return Response
*/
public function bulkClone()
Expand Down
6 changes: 3 additions & 3 deletions src/app/Http/Controllers/Operations/BulkDeleteOperation.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ trait BulkDeleteOperation
/**
* Define which routes are needed for this operation.
*
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
*/
protected function setupBulkDeleteRoutes($segment, $routeName, $controller)
{
Expand Down
9 changes: 4 additions & 5 deletions src/app/Http/Controllers/Operations/CloneOperation.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ trait CloneOperation
/**
* Define which routes are needed for this operation.
*
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
*/
protected function setupCloneRoutes($segment, $routeName, $controller)
{
Expand Down Expand Up @@ -41,8 +41,7 @@ protected function setupCloneDefaults()
/**
* Create a duplicate of the current entry in the datatabase.
*
* @param int $id
*
* @param int $id
* @return Response
*/
public function clone($id)
Expand Down
6 changes: 3 additions & 3 deletions src/app/Http/Controllers/Operations/CreateOperation.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ trait CreateOperation
/**
* Define which routes are needed for this operation.
*
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
*/
protected function setupCreateRoutes($segment, $routeName, $controller)
{
Expand Down
9 changes: 4 additions & 5 deletions src/app/Http/Controllers/Operations/DeleteOperation.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ trait DeleteOperation
/**
* Define which routes are needed for this operation.
*
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
*/
protected function setupDeleteRoutes($segment, $routeName, $controller)
{
Expand Down Expand Up @@ -41,8 +41,7 @@ protected function setupDeleteDefaults()
/**
* Remove the specified resource from storage.
*
* @param int $id
*
* @param int $id
* @return string
*/
public function destroy($id)
Expand Down
8 changes: 4 additions & 4 deletions src/app/Http/Controllers/Operations/FetchOperation.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ trait FetchOperation
/**
* Define which routes are needed for this operation.
*
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
*/
protected function setupFetchOperationRoutes($segment, $routeName, $controller)
{
Expand All @@ -34,7 +34,7 @@ protected function setupFetchOperationRoutes($segment, $routeName, $controller)
/**
* Gets items from database and returns to selects.
*
* @param string|array $arg
* @param string|array $arg
* @return \Illuminate\Http\JsonResponse|Illuminate\Database\Eloquent\Collection|Illuminate\Pagination\LengthAwarePaginator
*/
private function fetch($arg)
Expand Down
6 changes: 3 additions & 3 deletions src/app/Http/Controllers/Operations/InlineCreateOperation.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ trait InlineCreateOperation
/**
* Define which routes are needed for this operation.
*
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
* @param string $segment Name of the current entity (singular). Used as first URL segment.
* @param string $routeName Prefix of the route name.
* @param string $controller Name of the current CrudController.
*/
protected function setupInlineCreateRoutes($segment, $routeName, $controller)
{
Expand Down
Loading