StyleCi

.styleci.yml

@@ -2,10 +2,13 @@ preset: laravel
 
 enabled:
     - concat_with_spaces
+    - phpdoc_separation
 
 disabled:
     - phpdoc_no_package
     - concat_without_spaces
+    - laravel_phpdoc_alignment
+    - laravel_phpdoc_separation
 
 finder:
     exclude:

app/Exceptions/Handler.php

@@ -51,6 +51,7 @@ public function report(Exception $exception)
      * @param \Exception $exception
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function render($request, Exception $exception)

app/HMS/Composers/ProxyComposer.php

@@ -39,6 +39,7 @@ public function __construct(
      * Bind data to the view.
      *
      * @param  View  $view
+     *
      * @return void
      */
     public function compose(View $view)

app/HMS/Doctrine/CarbonType.php

@@ -56,6 +56,7 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
      * @param AbstractPlatform $platform
      *
      * @return Carbon|null
+     *
      * @throws ConversionException
      * @throws InvalidArgumentException
      */

app/HMS/Entities/Governance/Proxy.php

@@ -23,6 +23,7 @@ class Proxy
 
     /**
      * User designating a proxy.
+     *
      * @var User
      */
     protected $principal;

app/HMS/Factories/Banking/AccountFactory.php

@@ -59,6 +59,7 @@ protected static function generatePaymentRef()
      * Generate a unique payment reference.
      *
      * @return string A unique (at the time of function-call) payment reference.
+     *
      * @link   http://www.bacs.co.uk/Bacs/Businesses/BacsDirectCredit/Receiving/Pages/PaymentReferenceInformation.aspx
      */
     protected function generateUniquePaymentRef()

app/HMS/Repositories/Instrumentation/Doctrine/DoctrineEventRepository.php

@@ -32,6 +32,7 @@ public function paginateByService(Service $service, $perPage = 50, $pageName = '
 
     /**
      * save Event to the DB.
+     *
      * @param  Event $event
      */
     public function save(Event $event)

app/HMS/Repositories/Instrumentation/Doctrine/DoctrineServiceRepository.php

@@ -20,6 +20,7 @@ public function findAll()
 
     /**
      * save Service to the DB.
+     *
      * @param  Service $service
      */
     public function save(Service $service)

app/HMS/Repositories/Instrumentation/EventRepository.php

@@ -18,6 +18,7 @@ public function paginateByService(Service $service, $perPage = 15, $pageName = '
 
     /**
      * save Event to the DB.
+     *
      * @param  Event $event
      */
     public function save(Event $event);

app/HMS/Repositories/Instrumentation/ServiceRepository.php

@@ -15,6 +15,7 @@ public function findAll();
 
     /**
      * save Service to the DB.
+     *
      * @param  Service $service
      */
     public function save(Service $service);

app/Http/Controllers/Api/Auth/CanCheckController.php

@@ -21,6 +21,7 @@ public function __construct()
      * Handle the incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
+     *
      * @return \Illuminate\Http\Response
      */
     public function __invoke(Request $request)

app/Http/Controllers/Api/Gatekeeper/RegisterRfidTagController.php

@@ -57,6 +57,7 @@ public function __construct(
      * Handle the incoming request.
      *
      * @param  \Illuminate\Http\Request  $request
+     *
      * @return \Illuminate\Http\Response
      */
     public function __invoke(Request $request)

app/Http/Controllers/Api/Members/BoxController.php

@@ -115,6 +115,7 @@ public function __construct(
      * @param \Illuminate\Http\Request $request
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Doctrine\ORM\EntityNotFoundException
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
@@ -144,6 +145,7 @@ public function index(Request $request)
      * @param Box $box the Box
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function show(Box $box)
@@ -161,6 +163,7 @@ public function show(Box $box)
      * @param \Illuminate\Http\Request $request
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Doctrine\ORM\EntityNotFoundException
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
@@ -261,6 +264,7 @@ public function store(Request $request)
      * @param Box $box
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function printLabel(Box $box)
@@ -280,6 +284,7 @@ public function printLabel(Box $box)
      * @param Box $box
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function markInUse(Box $box)
@@ -342,6 +347,7 @@ public function markInUse(Box $box)
      * @param Box $box
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function markAbandoned(Box $box)
@@ -366,6 +372,7 @@ public function markAbandoned(Box $box)
      * @param Box $box
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function markRemoved(Box $box)

app/Http/Controllers/Api/Members/ProjectController.php

@@ -63,6 +63,7 @@ public function __construct(
      * @param \Illuminate\Http\Request $request
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Doctrine\ORM\EntityNotFoundException
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
@@ -112,6 +113,7 @@ public function store(Request $request)
      * @param Project $project
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function show(Project $project)
@@ -130,6 +132,7 @@ public function show(Project $project)
      * @param Project $project
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function update(Request $request, Project $project)
@@ -156,6 +159,7 @@ public function update(Request $request, Project $project)
      * @param Project $project
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function printLabel(Project $project)
@@ -175,6 +179,7 @@ public function printLabel(Project $project)
      * @param Project $project
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function markActive(Project $project)
@@ -195,6 +200,7 @@ public function markActive(Project $project)
      * @param Project $project
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function markAbandoned(Project $project)
@@ -215,6 +221,7 @@ public function markAbandoned(Project $project)
      * @param Project $project
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function markComplete(Project $project)

app/Http/Controllers/Api/UserController.php

@@ -55,6 +55,7 @@ public function __construct(
      * @param User $user
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function index()
@@ -70,6 +71,7 @@ public function index()
      * @param User $user
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function show(User $user)
@@ -88,6 +90,7 @@ public function show(User $user)
      * @param User $user
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function update(Request $request, User $user)

app/Http/Controllers/Banking/Account/AccountBankTransactionController.php

@@ -52,6 +52,7 @@ public function __construct(
      * Show the form for creating a new resource.
      *
      * @param  Account  $account
+     *
      * @return \Illuminate\Http\Response
      */
     public function create(Account $account)
@@ -77,6 +78,7 @@ public function create(Account $account)
      *
      * @param  \Illuminate\Http\Request  $request
      * @param  Account  $account
+     *
      * @return \Illuminate\Http\Response
      */
     public function store(Request $request, Account $account)

app/Http/Controllers/Banking/Bank/BankBankTransactionController.php

@@ -62,6 +62,7 @@ public function __construct(
      * Show the form for creating a new resource.
      *
      * @param  \App\Bank  $bank
+     *
      * @return \Illuminate\Http\Response
      */
     public function create(Bank $bank)
@@ -82,6 +83,7 @@ public function create(Bank $bank)
      *
      * @param  \Illuminate\Http\Request  $request
      * @param  \App\Bank  $bank
+     *
      * @return \Illuminate\Http\Response
      */
     public function store(Request $request, Bank $bank)
@@ -118,6 +120,7 @@ public function store(Request $request, Bank $bank)
      * Show the form for uploading an OFX file.
      *
      * @param  \App\Bank  $bank
+     *
      * @return \Illuminate\Http\Response
      */
     public function createViaOfxUpload(Bank $bank)
@@ -146,6 +149,7 @@ public function createViaOfxUpload(Bank $bank)
      *
      * @param  \Illuminate\Http\Request  $request
      * @param  \App\Bank  $bank
+     *
      * @return \Illuminate\Http\Response
      */
     public function storeOfx(Request $request, Bank $bank)

app/Http/Controllers/Banking/BankController.php

@@ -76,6 +76,7 @@ public function create()
      * Store a newly created resource in storage.
      *
      * @param  \Illuminate\Http\Request  $request
+     *
      * @return \Illuminate\Http\Response
      */
     public function store(Request $request)
@@ -109,6 +110,7 @@ public function store(Request $request)
      * Display the specified resource.
      *
      * @param  \HMS\Entities\Banking\Bank  $bank
+     *
      * @return \Illuminate\Http\Response
      */
     public function show(Bank $bank)
@@ -124,6 +126,7 @@ public function show(Bank $bank)
      * Show the form for editing the specified resource.
      *
      * @param  \HMS\Entities\Banking\Bank  $bank
+     *
      * @return \Illuminate\Http\Response
      */
     public function edit(Bank $bank)
@@ -137,6 +140,7 @@ public function edit(Bank $bank)
      *
      * @param  \Illuminate\Http\Request  $request
      * @param  \HMS\Entities\Banking\Bank  $bank
+     *
      * @return \Illuminate\Http\Response
      */
     public function update(Request $request, Bank $bank)

app/Http/Controllers/ContentBlockController.php

@@ -42,6 +42,7 @@ public function index()
      * Display the specified resource.
      *
      * @param  \HMS\Entities\ContentBlock  $contentBlock
+     *
      * @return \Illuminate\Http\Response
      */
     public function show(ContentBlock $contentBlock)
@@ -53,6 +54,7 @@ public function show(ContentBlock $contentBlock)
      * Show the form for editing the specified resource.
      *
      * @param  \HMS\Entities\ContentBlock  $contentBlock
+     *
      * @return \Illuminate\Http\Response
      */
     public function edit(ContentBlock $contentBlock)
@@ -65,6 +67,7 @@ public function edit(ContentBlock $contentBlock)
      *
      * @param  \Illuminate\Http\Request  $request
      * @param  \HMS\Entities\ContentBlock  $contentBlock
+     *
      * @return \Illuminate\Http\Response
      */
     public function update(Request $request, ContentBlock $contentBlock)

app/Http/Controllers/Tools/ToolController.php

@@ -178,6 +178,7 @@ public function show(Tool $tool)
      * @param string $grantType
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function showUsersForGrant(Tool $tool, string $grantType)
@@ -287,6 +288,7 @@ public function destroy(Tool $tool)
      * @param Tool $tool
      *
      * @return \Illuminate\Http\Response
+     *
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function grant(Request $request, Tool $tool)

app/Http/Resources/Gatekeeper/RfidTagResource.php

@@ -11,6 +11,7 @@ class RfidTagResource extends JsonResource
      * Transform the resource into an array.
      *
      * @param  \Illuminate\Http\Request  $request
+     *
      * @return array
      */
     public function toArray($request)

app/Listeners/Gatekeeper/NotifyNewBooking.php

@@ -45,6 +45,7 @@ public function __construct(
      * Handle the event.
      *
      * @param  NewBooking  $event
+     *
      * @return void
      */
     public function handle(NewBooking $event)

app/Listeners/Governance/NotifyCancelledProxy.php

@@ -33,6 +33,7 @@ public function __construct(RoleRepository $roleRepository)
      * Handle the event.
      *
      * @param  ProxyCancelled  $event
+     *
      * @return void
      */
     public function handle(ProxyCancelled $event)

app/Listeners/Governance/NotifyCheckedInProxy.php

@@ -22,6 +22,7 @@ public function __construct()
      * Handle the event.
      *
      * @param  ProxyCheckedIn  $event
+     *
      * @return void
      */
     public function handle(ProxyCheckedIn $event)

app/Listeners/Governance/NotifyNewProxyRegistered.php

@@ -33,6 +33,7 @@ public function __construct(RoleRepository $roleRepository)
      * Handle the event.
      *
      * @param  ProxyRegistered  $event
+     *
      * @return void
      */
     public function handle(ProxyRegistered $event)