Fix formatting and interfaces in nearly every file

This commit is contained in:
Nabeel Shahzad
2018-03-19 20:50:40 -05:00
parent 04c5b9e7bf
commit ccf56ddec1
331 changed files with 3282 additions and 2492 deletions

View File

@@ -2,30 +2,31 @@
namespace App\Http\Controllers\Api;
use App\Interfaces\Controller;
use App\Repositories\AcarsRepository;
use App\Repositories\PirepRepository;
use App\Services\GeoService;
use Illuminate\Http\Request;
class AcarsController extends RestController
/**
* Class AcarsController
* @package App\Http\Controllers\Api
*/
class AcarsController extends Controller
{
protected $acarsRepo, $geoSvc, $pirepRepo;
private $acarsRepo,
$geoSvc;
/**
* AcarsController constructor.
* @param GeoService $geoSvc
* @param GeoService $geoSvc
* @param AcarsRepository $acarsRepo
* @param PirepRepository $pirepRepo
*/
public function __construct(
GeoService $geoSvc,
AcarsRepository $acarsRepo,
PirepRepository $pirepRepo
AcarsRepository $acarsRepo
) {
$this->geoSvc = $geoSvc;
$this->acarsRepo = $acarsRepo;
$this->pirepRepo = $pirepRepo;
}
/**

View File

@@ -3,12 +3,17 @@
namespace App\Http\Controllers\Api;
use App\Http\Resources\Airline as AirlineResource;
use App\Interfaces\Controller;
use App\Repositories\AirlineRepository;
use Illuminate\Http\Request;
class AirlineController extends RestController
/**
* Class AirlineController
* @package App\Http\Controllers\Api
*/
class AirlineController extends Controller
{
protected $airlineRepo;
private $airlineRepo;
/**
* AirlineController constructor.
@@ -43,6 +48,7 @@ class AirlineController extends RestController
public function get($id)
{
$id = strtoupper($id);
return new AirlineResource($this->airlineRepo->find($id));
}
}

View File

@@ -3,15 +3,20 @@
namespace App\Http\Controllers\Api;
use App\Http\Resources\Airport as AirportResource;
use App\Interfaces\Controller;
use App\Repositories\AirportRepository;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Cache;
use Log;
use VaCentral\Airport as AirportLookup;
class AirportController extends RestController
/**
* Class AirportController
* @package App\Http\Controllers\Api
*/
class AirportController extends Controller
{
protected $airportRepo;
private $airportRepo;
/**
* AirportController constructor.
@@ -66,6 +71,7 @@ class AirportController extends RestController
public function get($id)
{
$id = strtoupper($id);
return new AirportResource($this->airportRepo->find($id));
}
@@ -77,13 +83,14 @@ class AirportController extends RestController
public function lookup($id)
{
$airport = Cache::remember(
config('cache.keys.AIRPORT_VACENTRAL_LOOKUP.key') . $id,
config('cache.keys.AIRPORT_VACENTRAL_LOOKUP.key').$id,
config('cache.keys.RANKS_PILOT_LIST.time'),
function () use ($id) {
try {
return AirportLookup::get($id);
} catch (\VaCentral\HttpException $e) {
Log::error($e);
return [];
}
}

View File

@@ -4,13 +4,19 @@ namespace App\Http\Controllers\Api;
use App\Http\Resources\Aircraft as AircraftResource;
use App\Http\Resources\Subfleet as SubfleetResource;
use App\Interfaces\Controller;
use App\Repositories\AircraftRepository;
use App\Repositories\SubfleetRepository;
use Illuminate\Http\Request;
class FleetController extends RestController
/**
* Class FleetController
* @package App\Http\Controllers\Api
*/
class FleetController extends Controller
{
protected $aircraftRepo, $subfleetRepo;
private $aircraftRepo,
$subfleetRepo;
/**
* FleetController constructor.
@@ -32,8 +38,8 @@ class FleetController extends RestController
public function index()
{
$subfleets = $this->subfleetRepo
->with(['aircraft', 'airline', 'fares', 'ranks'])
->paginate();
->with(['aircraft', 'airline', 'fares', 'ranks'])
->paginate();
return SubfleetResource::collection($subfleets);
}
@@ -41,23 +47,23 @@ class FleetController extends RestController
/**
* Get a specific aircraft. Query string required to specify the tail
* /api/aircraft/XYZ?type=registration
* @param $id
* @param $id
* @param Request $request
* @return AircraftResource
*/
public function get_aircraft($id, Request $request)
{
$where = [];
if($request->filled('type')) {
if ($request->filled('type')) {
$where[$request->get('type')] = $id;
} else {
$where['id'] = $id;
}
$aircraft = $this->aircraftRepo
->with(['subfleet', 'subfleet.fares'])
->findWhere($where)
->first();
->with(['subfleet', 'subfleet.fares'])
->findWhere($where)
->first();
return new AircraftResource($aircraft);
}

View File

@@ -4,10 +4,10 @@ namespace App\Http\Controllers\Api;
use App\Http\Resources\Flight as FlightResource;
use App\Http\Resources\Navdata as NavdataResource;
use App\Interfaces\Controller;
use App\Repositories\Criteria\WhereCriteria;
use App\Repositories\FlightRepository;
use App\Services\FlightService;
use App\Services\UserService;
use Auth;
use Illuminate\Http\Request;
use Prettus\Repository\Criteria\RequestCriteria;
@@ -17,24 +17,22 @@ use Prettus\Repository\Exceptions\RepositoryException;
* Class FlightController
* @package App\Http\Controllers\Api
*/
class FlightController extends RestController
class FlightController extends Controller
{
protected $flightRepo, $flightSvc, $userSvc;
private $flightRepo,
$flightSvc;
/**
* FlightController constructor.
* @param FlightRepository $flightRepo
* @param FlightService $flightSvc
* @param UserService $userSvc
* @param FlightService $flightSvc
*/
public function __construct(
FlightRepository $flightRepo,
FlightService $flightSvc,
UserService $userSvc
FlightService $flightSvc
) {
$this->flightRepo = $flightRepo;
$this->flightSvc = $flightSvc;
$this->userSvc = $userSvc;
}
/**
@@ -52,10 +50,10 @@ class FlightController extends RestController
}
$flights = $this->flightRepo
->whereOrder($where, 'flight_number', 'asc')
->paginate();
->whereOrder($where, 'flight_number', 'asc')
->paginate();
foreach($flights as $flight) {
foreach ($flights as $flight) {
$this->flightSvc->filterSubfleets($user, $flight);
}
@@ -105,7 +103,7 @@ class FlightController extends RestController
/**
* Get a flight's route
* @param $id
* @param $id
* @param Request $request
* @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
*/

View File

@@ -16,6 +16,7 @@ use App\Http\Resources\AcarsRoute as AcarsRouteResource;
use App\Http\Resources\JournalTransaction as JournalTransactionResource;
use App\Http\Resources\Pirep as PirepResource;
use App\Http\Resources\PirepComment as PirepCommentResource;
use App\Interfaces\Controller;
use App\Models\Acars;
use App\Models\Enums\AcarsType;
use App\Models\Enums\PirepSource;
@@ -35,7 +36,11 @@ use Auth;
use Illuminate\Http\Request;
use Log;
class PirepController extends RestController
/**
* Class PirepController
* @package App\Http\Controllers\Api
*/
class PirepController extends Controller
{
private $acarsRepo,
$fareSvc,
@@ -48,13 +53,14 @@ class PirepController extends RestController
/**
* PirepController constructor.
* @param AcarsRepository $acarsRepo
* @param AcarsRepository $acarsRepo
* @param FareService $fareSvc
* @param PirepFinanceService $financeSvc
* @param GeoService $geoSvc
* @param JournalRepository $journalRepo
* @param PirepRepository $pirepRepo
* @param PirepService $pirepSvc
* @param UserService $userSvc
* @param GeoService $geoSvc
* @param JournalRepository $journalRepo
* @param PirepRepository $pirepRepo
* @param PirepService $pirepSvc
* @param UserService $userSvc
*/
public function __construct(
AcarsRepository $acarsRepo,
@@ -98,7 +104,7 @@ class PirepController extends RestController
}
/**
* @param $pirep
* @param $pirep
* @param Request $request
*/
protected function updateFields($pirep, Request $request)
@@ -110,8 +116,8 @@ class PirepController extends RestController
$pirep_fields = [];
foreach ($request->input('fields') as $field_name => $field_value) {
$pirep_fields[] = [
'name' => $field_name,
'value' => $field_value,
'name' => $field_name,
'value' => $field_value,
'source' => $pirep->source,
];
}
@@ -121,21 +127,21 @@ class PirepController extends RestController
/**
* Save the fares
* @param $pirep
* @param $pirep
* @param Request $request
* @throws \Exception
*/
protected function updateFares($pirep, Request $request)
{
if(!$request->filled('fares')) {
if (!$request->filled('fares')) {
return;
}
$fares = [];
foreach($request->post('fares') as $fare) {
foreach ($request->post('fares') as $fare) {
$fares[] = [
'fare_id' => $fare['id'],
'count' => $fare['count'],
'count' => $fare['count'],
];
}
@@ -168,7 +174,7 @@ class PirepController extends RestController
$pirep = new Pirep($attrs);
# See if this user is allowed to fly this aircraft
if(setting('pireps.restrict_aircraft_to_rank', false)) {
if (setting('pireps.restrict_aircraft_to_rank', false)) {
$can_use_ac = $this->userSvc->aircraftAllowed($user, $pirep->aircraft_id);
if (!$can_use_ac) {
throw new AircraftPermissionDenied();
@@ -177,7 +183,7 @@ class PirepController extends RestController
# Find if there's a duplicate, if so, let's work on that
$dupe_pirep = $this->pirepSvc->findDuplicate($pirep);
if($dupe_pirep !== false) {
if ($dupe_pirep !== false) {
$pirep = $dupe_pirep;
$this->checkCancelled($pirep);
}
@@ -198,7 +204,7 @@ class PirepController extends RestController
* Once ACARS updates are being processed, then it can go into an 'ENROUTE'
* status, and whatever other statuses may be defined
*
* @param $id
* @param $id
* @param UpdateRequest $request
* @return PirepResource
* @throws \App\Exceptions\PirepCancelled
@@ -208,7 +214,7 @@ class PirepController extends RestController
*/
public function update($id, UpdateRequest $request)
{
Log::info('PIREP Update, user ' . Auth::id(), $request->post());
Log::info('PIREP Update, user '.Auth::id(), $request->post());
$user = Auth::user();
$pirep = $this->pirepRepo->find($id);
@@ -236,7 +242,7 @@ class PirepController extends RestController
/**
* File the PIREP
* @param $id
* @param $id
* @param FileRequest $request
* @return PirepResource
* @throws \App\Exceptions\PirepCancelled
@@ -246,7 +252,7 @@ class PirepController extends RestController
*/
public function file($id, FileRequest $request)
{
Log::info('PIREP file, user ' . Auth::id(), $request->post());
Log::info('PIREP file, user '.Auth::id(), $request->post());
$user = Auth::user();
@@ -283,7 +289,7 @@ class PirepController extends RestController
# route that's been posted from the PIREP
$w = ['pirep_id' => $pirep->id, 'type' => AcarsType::ROUTE];
$count = Acars::where($w)->count(['id']);
if($count === 0) {
if ($count === 0) {
$this->pirepSvc->saveRoute($pirep);
}
@@ -292,14 +298,14 @@ class PirepController extends RestController
/**
* Cancel the PIREP
* @param $id
* @param $id
* @param Request $request
* @return PirepResource
* @throws \Prettus\Validator\Exceptions\ValidatorException
*/
public function cancel($id, Request $request)
{
Log::info('PIREP Cancel, user ' . Auth::id(), $request->post());
Log::info('PIREP Cancel, user '.Auth::id(), $request->post());
$pirep = $this->pirepRepo->update([
'state' => PirepState::CANCELLED,
@@ -310,7 +316,7 @@ class PirepController extends RestController
/**
* Return the GeoJSON for the ACARS line
* @param $id
* @param $id
* @param Request $request
* @return \Illuminate\Contracts\Routing\ResponseFactory
*/
@@ -326,7 +332,7 @@ class PirepController extends RestController
/**
* Return the routes for the ACARS line
* @param $id
* @param $id
* @param Request $request
* @return AcarsRouteResource
*/
@@ -336,13 +342,13 @@ class PirepController extends RestController
return new AcarsRouteResource(Acars::where([
'pirep_id' => $id,
'type' => AcarsType::FLIGHT_PATH
'type' => AcarsType::FLIGHT_PATH
])->orderBy('created_at', 'asc')->get());
}
/**
* Post ACARS updates for a PIREP
* @param $id
* @param $id
* @param PositionRequest $request
* @return \Illuminate\Http\JsonResponse
* @throws \App\Exceptions\PirepCancelled
@@ -361,8 +367,7 @@ class PirepController extends RestController
$count = 0;
$positions = $request->post('positions');
foreach($positions as $position)
{
foreach ($positions as $position) {
$position['pirep_id'] = $id;
$position['type'] = AcarsType::FLIGHT_PATH;
@@ -376,13 +381,13 @@ class PirepController extends RestController
$pirep->status = PirepStatus::ENROUTE;
$pirep->save();
return $this->message($count . ' positions added', $count);
return $this->message($count.' positions added', $count);
}
/**
* Post ACARS LOG update for a PIREP. These updates won't show up on the map
* But rather in a log file.
* @param $id
* @param $id
* @param LogRequest $request
* @return \Illuminate\Http\JsonResponse
* @throws \App\Exceptions\PirepCancelled
@@ -398,8 +403,7 @@ class PirepController extends RestController
$count = 0;
$logs = $request->post('logs');
foreach($logs as $log) {
foreach ($logs as $log) {
$log['pirep_id'] = $id;
$log['type'] = AcarsType::LOG;
@@ -408,13 +412,13 @@ class PirepController extends RestController
++$count;
}
return $this->message($count . ' logs added', $count);
return $this->message($count.' logs added', $count);
}
/**
* Post ACARS LOG update for a PIREP. These updates won't show up on the map
* But rather in a log file.
* @param $id
* @param $id
* @param EventRequest $request
* @return \Illuminate\Http\JsonResponse
* @throws \App\Exceptions\PirepCancelled
@@ -426,12 +430,11 @@ class PirepController extends RestController
$pirep = $this->pirepRepo->find($id);
$this->checkCancelled($pirep);
Log::debug('Posting ACARS event, PIREP: ' . $id, $request->post());
Log::debug('Posting ACARS event, PIREP: '.$id, $request->post());
$count = 0;
$logs = $request->post('events');
foreach ($logs as $log) {
$log['pirep_id'] = $id;
$log['type'] = AcarsType::LOG;
$log['log'] = $log['event'];
@@ -441,24 +444,25 @@ class PirepController extends RestController
++$count;
}
return $this->message($count . ' logs added', $count);
return $this->message($count.' logs added', $count);
}
/**
* Add a new comment
* @param $id
* @param $id
* @param Request $request
* @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
*/
public function comments_get($id, Request $request)
{
$pirep = $this->pirepRepo->find($id);
return PirepCommentResource::collection($pirep->comments);
}
/**
* Add a new comment
* @param $id
* @param $id
* @param CommentRequest $request
* @return PirepCommentResource
* @throws \App\Exceptions\PirepCancelled
@@ -480,7 +484,7 @@ class PirepController extends RestController
}
/**
* @param $id
* @param $id
* @param Request $request
* @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
* @throws \UnexpectedValueException
@@ -490,11 +494,12 @@ class PirepController extends RestController
{
$pirep = $this->pirepRepo->find($id);
$transactions = $this->journalRepo->getAllForObject($pirep);
return JournalTransactionResource::collection($transactions);
}
/**
* @param $id
* @param $id
* @param Request $request
* @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
* @throws \UnexpectedValueException
@@ -509,11 +514,12 @@ class PirepController extends RestController
$pirep->refresh();
$transactions = $this->journalRepo->getAllForObject($pirep);
return JournalTransactionResource::collection($transactions['transactions']);
}
/**
* @param $id
* @param $id
* @param Request $request
* @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
*/
@@ -523,13 +529,13 @@ class PirepController extends RestController
return AcarsRouteResource::collection(Acars::where([
'pirep_id' => $id,
'type' => AcarsType::ROUTE
'type' => AcarsType::ROUTE
])->orderBy('order', 'asc')->get());
}
/**
* Post the ROUTE for a PIREP, can be done from the ACARS log
* @param $id
* @param $id
* @param RouteRequest $request
* @return \Illuminate\Http\JsonResponse
* @throws \App\Exceptions\PirepCancelled
@@ -545,7 +551,7 @@ class PirepController extends RestController
$count = 0;
$route = $request->post('route', []);
foreach($route as $position) {
foreach ($route as $position) {
$position['pirep_id'] = $id;
$position['type'] = AcarsType::ROUTE;
@@ -555,11 +561,11 @@ class PirepController extends RestController
++$count;
}
return $this->message($count . ' points added', $count);
return $this->message($count.' points added', $count);
}
/**
* @param $id
* @param $id
* @param Request $request
* @return \Illuminate\Http\JsonResponse
* @throws \Exception
@@ -570,7 +576,7 @@ class PirepController extends RestController
Acars::where([
'pirep_id' => $id,
'type' => AcarsType::ROUTE
'type' => AcarsType::ROUTE
])->delete();
return $this->message('Route deleted');

View File

@@ -1,94 +0,0 @@
<?php
namespace App\Http\Controllers\Api;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
class RestController
{
/**
* Shortcut function to get the attributes from a request while running the validations
* @param Request $request
* @param array $attrs_or_validations
* @param array $addtl_fields
* @return array
* @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
*/
public function getFromReq($request, $attrs_or_validations, $addtl_fields=null)
{
# See if a list of values is passed in, or if a validation list is passed in
$is_validation = false;
if(\count(array_filter(array_keys($attrs_or_validations), '\is_string')) > 0) {
$is_validation = true;
}
if($is_validation) {
$this->validate($request, $attrs_or_validations);
}
$fields = [];
foreach($attrs_or_validations as $idx => $field) {
if($is_validation) {
$field = $idx;
}
if($request instanceof Request) {
if ($request->filled($field)) {
$fields[$field] = $request->input($field);
}
} else {
if(array_key_exists($field, $request)) {
$fields[$field] = $request[$field];
}
}
}
if(!empty($addtl_fields) && \is_array($addtl_fields)) {
$fields = array_merge($fields, $addtl_fields);
}
return $fields;
}
/**
* Run a validation
* @param $request
* @param $rules
* @return bool
* @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
*/
public function validate($request, $rules)
{
if($request instanceof Request) {
$validator = Validator::make($request->all(), $rules);
} else {
$validator = Validator::make($request, $rules);
}
if (!$validator->passes()) {
throw new BadRequestHttpException($validator->errors(), null, 400);
}
return true;
}
/**
* Simple normalized method for forming the JSON responses
* @param $message
* @return \Illuminate\Http\JsonResponse
*/
public function message($message, $count=null)
{
$attrs = [
'message' => $message
];
if($count !== null) {
$attrs['count'] = $count;
}
return response()->json($attrs);
}
}

View File

@@ -3,12 +3,17 @@
namespace App\Http\Controllers\Api;
use App\Http\Resources\Setting as SettingResource;
use App\Interfaces\Controller;
use App\Repositories\SettingRepository;
use Illuminate\Http\Request;
class SettingsController extends RestController
/**
* Class SettingsController
* @package App\Http\Controllers\Api
*/
class SettingsController extends Controller
{
protected $settingRepo;
private $settingRepo;
/**
* SettingsController constructor.

View File

@@ -2,9 +2,14 @@
namespace App\Http\Controllers\Api;
use App\Interfaces\Controller;
use PragmaRX\Version\Package\Facade as Version;
class StatusController extends RestController
/**
* Class StatusController
* @package App\Http\Controllers\Api
*/
class StatusController extends Controller
{
/**
* @return \Illuminate\Http\JsonResponse
@@ -13,7 +18,7 @@ class StatusController extends RestController
{
return response()->json([
'version' => Version::compact(),
'php' => PHP_VERSION,
'php' => PHP_VERSION,
]);
}
}

View File

@@ -3,12 +3,12 @@
namespace App\Http\Controllers\Api;
use App\Http\Resources\Bid as BidResource;
use App\Http\Resources\Flight as FlightResource;
use App\Http\Resources\Pirep as PirepResource;
use App\Http\Resources\Subfleet as SubfleetResource;
use App\Http\Resources\User as UserResource;
use App\Models\Enums\PirepState;
use App\Interfaces\Controller;
use App\Models\Bid;
use App\Models\Enums\PirepState;
use App\Repositories\Criteria\WhereCriteria;
use App\Repositories\FlightRepository;
use App\Repositories\PirepRepository;
@@ -21,24 +21,27 @@ use Illuminate\Http\Request;
use Prettus\Repository\Criteria\RequestCriteria;
use Prettus\Repository\Exceptions\RepositoryException;
class UserController extends RestController
/**
* Class UserController
* @package App\Http\Controllers\Api
*/
class UserController extends Controller
{
protected $flightRepo,
$flightSvc,
$pirepRepo,
$subfleetRepo,
$userRepo,
$userSvc;
private $flightRepo,
$flightSvc,
$pirepRepo,
$subfleetRepo,
$userRepo,
$userSvc;
/**
* UserController constructor.
* @param FlightRepository $flightRepo
* @param FlightService $flightSvc
* @param PirepRepository $pirepRepo
* @param FlightRepository $flightRepo
* @param FlightService $flightSvc
* @param PirepRepository $pirepRepo
* @param SubfleetRepository $subfleetRepo
* @param UserRepository $userRepo
* @param UserService $userSvc
* @param UserRepository $userRepo
* @param UserService $userSvc
*/
public function __construct(
FlightRepository $flightRepo,
@@ -106,11 +109,12 @@ class UserController extends RestController
$flight_id = $request->input('flight_id');
$flight = $this->flightRepo->find($flight_id);
$bid = $this->flightSvc->addBid($flight, $user);
return new BidResource($bid);
}
if ($request->isMethod('DELETE')) {
if($request->filled('bid_id')) {
if ($request->filled('bid_id')) {
$bid = Bid::findOrFail($request->input('bid_id'));
$flight_id = $bid->flight_id;
} else {
@@ -123,6 +127,7 @@ class UserController extends RestController
# Return the flights they currently have bids on
$bids = Bid::where(['user_id' => $user->id])->get();
return BidResource::collection($bids);
}
@@ -152,7 +157,7 @@ class UserController extends RestController
'user_id' => $this->getUserId($request),
];
if(filled($request->query('state'))) {
if (filled($request->query('state'))) {
$where['state'] = $request->query('state');
} else {
$where[] = ['state', '!=', PirepState::CANCELLED];