DavideCasiraghi\LaravelEventsCalendar\Http\Controllers\TeacherController

Complexity

Total Complexity

20

Size/Duplication

Total Lines	303
Duplicated Lines	0 %

Test Coverage

Coverage

95.54%

Importance

Changes	9
Bugs	2	Features	2

12 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	10	1
A	destroy()	0	6	1
A	teachersValidator()	0	25	2
A	show()	0	28	1
A	edit()	0	10	1
A	storeFromModal()	0	9	1
A	modal()	0	8	1
A	__construct()	0	3	1
A	update()	0	14	2
A	index()	0	57	5
A	store()	0	14	2
A	teacherBySlug()	0	9	2

<?php

namespace DavideCasiraghi\LaravelEventsCalendar\Http\Controllers;

use Carbon\Carbon;
use DavideCasiraghi\LaravelEventsCalendar\Models\Country;
use DavideCasiraghi\LaravelEventsCalendar\Models\Event;
use DavideCasiraghi\LaravelEventsCalendar\Models\EventCategory;
use DavideCasiraghi\LaravelEventsCalendar\Models\EventRepetition;
use DavideCasiraghi\LaravelEventsCalendar\Models\Teacher;
use Illuminate\Foundation\Auth\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Route;
use Validator;

class TeacherController extends Controller
{
    /* Restrict the access to this resource just to logged in users except show and index view */
    public function __construct()
    {
        $this->middleware('auth', ['except' => ['index', 'show', 'teacherBySlug']]);
    }

    /***************************************************************************/

    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\View\View
     */
    public function index(Request $request)
    {
        //$countries = Country::orderBy('countries.name')->pluck('name', 'id');

        $countries = Country::getCountriesWithTeachers();

        // Get the countries with active teachers - BUG! IF I CACHE JUST A PART OF THE COUNTRIES WHEN I INSERT A NEW TEACHER WITH A COUNTRY THAT IS NOT IN THE CACHE I GET AN ERROR WHEN I'M BACK TO THE INDEX (eg.no index error)
        /*    $cacheExpireTime = 900; // Set the duration time of the cache (15 min - 900sec)
            $countries = Cache::remember('teachers_countries', cacheExpireTime, function () {
                return DB::table('countries')
                    ->join('teachers', 'countries.id', '=', 'teachers.country_id')
                    ->orderBy('countries.name')
                    ->pluck('countries.name', 'countries.id');
            });*/

        // Search keywords
        $searchKeywords = $request->input('keywords');
        $searchCountry = $request->input('country_id');

        // To show just the teachers created by the the user - If admin or super admin is set to null show all the teachers
        $authorUserId = ($this->getLoggedAuthorId()) ? $this->getLoggedAuthorId() : null; // if is 0 (super admin or admin) it's setted to null to avoid include it in the query

        // To retrieve all the teachers when the route is teacher.directory, we set the logged user id to null
        if (Route::currentRouteName() == 'teachers.directory') {
            $authorUserId = null;
        }

        if ($searchKeywords || $searchCountry) {
            $teachers = DB::table('teachers')
                ->when($authorUserId, function ($query, $authorUserId) {
                    return $query->where('created_by', $authorUserId);
                })
                ->when($searchKeywords, function ($query, $searchKeywords) {
                    return $query->where('name', $searchKeywords)->orWhere('name', 'like', '%'.$searchKeywords.'%');
                })
                ->when($searchCountry, function ($query, $searchCountry) {
                    return $query->where('country_id', '=', $searchCountry);
                })
                ->orderBy('name')
                ->paginate(20);
        } else {
            $teachers = Teacher::
            when($authorUserId, function ($query, $authorUserId) {
                return $query->where('created_by', $authorUserId);
            })
            ->orderBy('name')
            ->paginate(20);
        }

        //return view('teachers.index', compact('teachers'))
        return view('laravel-events-calendar::teachers.index', compact('teachers'))
        //return view('laravel-events-calendar::teachers.index')
            ->with('i', (request()->input('page', 1) - 1) * 20)
            ->with('countries', $countries)
            ->with('searchKeywords', $searchKeywords)
            ->with('searchCountry', $searchCountry)
            ->with('loggedUser', $authorUserId);
    }

    /***************************************************************************/

    /**
     * Show the form for creating a new resource.
     *
     * @return \Illuminate\View\View
     */
    public function create()
    {
        $countries = Country::getCountries();
        $users = User::pluck('name', 'id');
        $authorUserId = $this->getLoggedAuthorId();

        return view('laravel-events-calendar::teachers.create')
            ->with('countries', $countries)
            ->with('users', $users)
            ->with('authorUserId', $authorUserId);
    }

    /***************************************************************************/

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store(Request $request)
    {
        // Validate form datas
        $validator = $this->teachersValidator($request);
        if ($validator->fails()) {
            return back()->withErrors($validator)->withInput();
        }

        $teacher = new Teacher();
        $teacher->preSave($request->all(), $request->file('profile_picture'));

It seems like $request->file('profile_picture') can also be of type Illuminate\Http\UploadedFile[] and array; however, parameter $profilePicture of DavideCasiraghi\LaravelEventsCalendar\Models\Teacher::preSave() does only seem to accept Illuminate\Http\UploadedFile, maybe add an additional type check?

        $teacher->save();

        return redirect()->route('teachers.index')
                        ->with('success', __('laravel-events-calendar::messages.teacher_added_successfully'));
    }

    /***************************************************************************/

    /**
     * Display the specified resource.
     *
     * @param  \DavideCasiraghi\LaravelEventsCalendar\Models\Teacher  $teacher
     * @return \Illuminate\View\View
     */
    public function show(Teacher $teacher)
    {
        // Get the name of the teacher's country
        $country = Country::select('name')
            ->where('id', $teacher->country_id)
            ->first();

        $cacheExpireTime = 900; // Set the duration time of the cache (15 min - 900sec)
        $eventCategories = Cache::remember('categories', $cacheExpireTime, function () {
            //return EventCategory::orderBy('name')->pluck('name', 'id');
            return EventCategory::listsTranslations('name')->pluck('name', 'id');
        });

        // Get for each event the first event repetition in the near future (JUST THE QUERY)
        date_default_timezone_set('Europe/Rome');
        $searchStartDate = date('Y-m-d', time()); // search start from today's date
        $lastestEventsRepetitionsQuery = EventRepetition::getLastestEventsRepetitionsQuery($searchStartDate, null);

        // Get the events where this teacher is teaching to
        //DB::enableQueryLog();
        $eventsTeacherWillTeach = Teacher::eventsByTeacher($teacher, $lastestEventsRepetitionsQuery);

        //dd(DB::getQueryLog());

        return view('laravel-events-calendar::teachers.show', compact('teacher'))
            ->with('country', $country)
            ->with('eventCategories', $eventCategories)
            ->with('eventsTeacherWillTeach', $eventsTeacherWillTeach);
    }

    /**
     * Show the form for editing the specified resource.
     *
     * @param  \DavideCasiraghi\LaravelEventsCalendar\Models\Teacher  $teacher
     * @return \Illuminate\View\View
     */
    public function edit(Teacher $teacher)
    {
        $authorUserId = $this->getLoggedAuthorId();
        $users = User::pluck('name', 'id');
        $countries = Country::getCountries();

        return view('laravel-events-calendar::teachers.edit', compact('teacher'))
            ->with('countries', $countries)
            ->with('users', $users)
            ->with('authorUserId', $authorUserId);
    }

    /***************************************************************************/

    /**
     * Update the specified resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \DavideCasiraghi\LaravelEventsCalendar\Models\Teacher  $teacher
     * @return \Illuminate\Http\RedirectResponse
     */
    public function update(Request $request, Teacher $teacher)
    {
        // Validate form datas
        $validator = $this->teachersValidator($request);
        //dd($validator->errors());
        if ($validator->fails()) {
            return back()->withErrors($validator)->withInput();
        }

        $teacher->preSave($request->all(), $request->file('profile_picture'));

It seems like $request->file('profile_picture') can also be of type Illuminate\Http\UploadedFile[] and array; however, parameter $profilePicture of DavideCasiraghi\LaravelEventsCalendar\Models\Teacher::preSave() does only seem to accept Illuminate\Http\UploadedFile, maybe add an additional type check?

        $teacher->save();

        return redirect()->route('teachers.index')
                        ->with('success', __('laravel-events-calendar::messages.teacher_updated_successfully'));
    }

    /***************************************************************************/

    /**
     * Remove the specified resource from storage.
     *
     * @param  \DavideCasiraghi\LaravelEventsCalendar\Models\Teacher  $teacher
     * @return \Illuminate\Http\RedirectResponse
     */
    public function destroy(Teacher $teacher)
    {
        $teacher->delete();

        return redirect()->route('teachers.index')
                        ->with('success', __('laravel-events-calendar::messages.teacher_deleted_successfully'));
    }

    /***************************************************************************/

    /**
     * Open a modal in the event view when 'create new teacher' button is clicked.
     *
     * @return \Illuminate\View\View
     */
    public function modal()
    {
        $countries = Country::getCountries();
        $users = User::pluck('name', 'id');

        return view('laravel-events-calendar::teachers.modal')
                ->with('countries', $countries)
                ->with('users', $users);
    }

    /***************************************************************************/

    /**
     * Store a newly created teacher from the create event view modal in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\JsonResponse
     */
    public function storeFromModal(Request $request)
    {
        $teacher = new Teacher();
        $teacher->preSave($request->all(), $request->file('profile_picture'));

It seems like $request->file('profile_picture') can also be of type Illuminate\Http\UploadedFile[] and array; however, parameter $profilePicture of DavideCasiraghi\LaravelEventsCalendar\Models\Teacher::preSave() does only seem to accept Illuminate\Http\UploadedFile, maybe add an additional type check?

        $teacher->save();

        return response()->json([
            'teacherId' => $teacher->id,
            'teacherName' => $teacher->name,
        ]);
    }

    /***************************************************************************/

    /**
     * Return the teacher by SLUG. (eg. http://websitename.com/teacher/xxxx).
     *
     * @param  string  $slug
     * @return \Illuminate\View\View
     */
    public function teacherBySlug($slug)
    {
        $teacher = Teacher::where('slug', $slug)->first();

        if (is_null($teacher)) {
            abort(404);
        }

        return $this->show($teacher);
    }

    /***************************************************************************/

    /**
     * Return the validator with all the defined constraint.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Contracts\Validation\Validator
     */
    public function teachersValidator(Request $request)
    {
        $maxYear = Carbon::now()->year;

        $rules = [
            'name' => 'required',
            'year_starting_practice' => 'required|integer|min:1972|max:'.($maxYear),
            'year_starting_teach' => 'required|integer|min:1972|max:'.($maxYear),
            'facebook' => 'nullable|url',
            'website' => 'nullable|url',
            // 'profile_picture' => 'nullable|image|mimes:jpeg,jpg,png|max:3000',   // BUG create problems to validate on edit. Fix this after the rollout
            // 'required_with:end_page|integer|min:1|digits_between: 1,5',  // https://stackoverflow.com/questions/32036882/laravel-validate-an-integer-field-that-needs-to-be-greater-than-another
        ];
        if ($request->hasFile('profile_picture')) {
            $rules['profile_picture'] = 'nullable|image|mimes:jpeg,jpg,png|max:5000';
        }
        $messages = [
            'facebook.url' => 'The facebook link is invalid. It should start with https://',
            'website.url' => 'The website link is invalid. It should start with https://',
            'profile_picture.max' => 'The maximum image size is 5MB. If you need to resize it you can use: www.simpleimageresizer.com',
        ];

        $validator = Validator::make($request->all(), $rules, $messages);

        return $validator;
    }
}