App\Http\Controllers\ExaminationStudentsController

Complexity

Total Complexity

33

Size/Duplication

Total Lines	266
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	2

11 Methods

Rating	Name	Duplication	Size	Complexity
A	export()	0	3	1
A	callOnClick()	0	7	1
A	getMatchingStudents()	0	8	3
A	index()	0	3	1
A	__construct()	0	9	1
A	doMatch()	0	5	1
A	updateStudentId()	0	6	1
B	searchSimilarName()	0	37	10
A	clone()	0	52	4
A	uploadFile()	0	40	4
B	setIsTakingExam()	0	22	6

<?php

namespace App\Http\Controllers;

use Session;
use App\Models\Institution;
use Illuminate\Http\Request;
use App\Models\Security_user;
use App\Models\Academic_period;
use App\Models\Education_grade;
use App\Models\Institution_class;
use App\Models\Examination_student;
use App\Models\Institution_student;
use Maatwebsite\Excel\Facades\Excel;
use Illuminate\Support\Facades\Storage;
use App\Models\Institution_class_student;
use App\Exports\ExaminationStudentsExport;
use App\Imports\ExaminationStudentsImport;
use App\Models\Institution_student_admission;

class ExaminationStudentsController extends Controller
{
    public function __construct($year = 2019, $grade = 'G5')
    {
        $this->year = $year;

The property year does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->grade = $grade;

The property grade does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->student = new Security_user();

The property student does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->examination_student = new Examination_student();

The property examination_student does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->academic_period =  Academic_period::where('code', '=', $this->year)->first();

The property academic_period does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->education_grade = Education_grade::where('code', '=', $this->grade)->first();

The property education_grade does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->output = new \Symfony\Component\Console\Output\ConsoleOutput();

The property output does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    public function index()
    {
        return view('uploadcsv');
    }

    public function uploadFile(Request $request)
    {

        if ($request->input('submit') != null) {

            $file = $request->file('file');

            // File Details
            $filename = 'exams_students.csv';
            $extension = $file->getClientOriginalExtension();
            $fileSize = $file->getSize();

            // Valid File Extensions
            $valid_extension = array("csv");

            // 20MB in Bytes
            $maxFileSize = 30971520;

            // Check file extension
            if (in_array(strtolower($extension), $valid_extension)) {

                // Check file size
                if ($fileSize <= $maxFileSize) {

                    // File upload location
                    Storage::disk('local')->putFileAs(
                        'examination/',
                        $file,

It seems like $file can also be of type Illuminate\Http\UploadedFile[] and array; however, parameter $file of Illuminate\Filesystem\FilesystemAdapter::putFileAs() does only seem to accept Illuminate\Http\File|Illuminate\Http\UploadedFile, maybe add an additional type check?

                        $filename
                    );
                    Session::flash('message', 'File upload successfully!');
                    // Redirect to index
                } else {
                    Session::flash('message', 'File too large. File must be less than 20MB.');
                }
            } else {
                Session::flash('message', 'Invalid File Extension.');
            }
        }
        return redirect()->action('ExaminationStudentsController@index');
    }

    /**
     * Import students data to the Examinations table 
     *
     * @return void
     */
    public static function callOnClick()
    {
        // Import CSV to Database
        $excelFile = "/examination/exams_students.csv";

        $import = new ExaminationStudentsImport();
        $import->import($excelFile, 'local', \Maatwebsite\Excel\Excel::CSV);
    }

    /**
     * Iterate over existing student's data
     *
     * @return void
     */
    public  function doMatch()
    {
        $students = Examination_student::get()->toArray();
        //    array_walk($students,array($this,'clone'));
        array_walk($students, array($this, 'clone'));
    }

    /**
     * Set Examination values
     *
     * @param array $students
     * @return array
     */
    public function setIsTakingExam($students){
        $students['taking_g5_exam'] = false;
        $students['taking_ol_exam'] = false;
        $students['taking_al_exam'] = false;
        switch($this->education_grade->code){

The property code does not seem to exist on App\Models\Education_grade. Are you sure there is no database migration missing?

            case 'G5':
                $students['taking_g5_exam'] = true;
                break;
            case 'G4':
                $students['taking_g5_exam'] = true;
                break;
            case 'G10':
                $students['taking_ol_exam'] = true;
                break;
            case 'G11':
                $students['taking_ol_exam'] = true;
                break;
            case preg_match('13',$this->education_grade->code):  
                $students['taking_al_exam'] = true;
                break;             
        }
        return $students;
    }


    /**
     * Main function to merge the student's to SIS
     *
     * @param array $student
     * @return void
     */
    public function clone($student)
    {
        //get student matching with same dob and gender
        $matchedStudent = $this->getMatchingStudents($student);

        // if the first match missing do complete insertion
        $institution = Institution::where('code', '=', $student['schoolid'])->first();

        if (!is_null($institution)) {

            // ge the class lists to belong the school
            $institutionClass = Institution_class::where(
                [
                    'institution_id' => $institution->id,
                    'academic_period_id' => $this->academic_period->id,
                    'education_grade_id' => $this->education_grade->id
                ]
            )->join('institution_class_grades', 'institution_classes.id', 'institution_class_grades.institution_class_id')->get()->toArray();

            // set search variables 
            $admissionInfo = [
                'instituion_class' => $institutionClass,
                'instituion' => $institution,
                'education_grade' =>  $this->education_grade,
                'academic_period' => $this->academic_period
            ];

            // if no matching found
            if (empty($matchedStudent)) {
                $sis_student = $this->student->insertExaminationStudent($student);
                $this->updateStudentId($student, $sis_student);

                //TODO implement insert student to admission table
                $student['id'] = $sis_student['id'];

                $student = $this->setIsTakingExam($student);
                if (count($institutionClass) == 1) {
                    $admissionInfo['instituion_class'] = $institutionClass[0];
                    Institution_student::createExaminationData($student, $admissionInfo);
                    Institution_student_admission::createExaminationData($student, $admissionInfo);
                    Institution_class_student::createExaminationData($student, $admissionInfo);
                } else {
                    Institution_student_admission::createExaminationData($student, $admissionInfo);
                    Institution_student::createExaminationData($student, $admissionInfo);
                }
                // update the matched student's data    
            } else {
                $student = $this->student->updateExaminationStudent($student, $matchedStudent);
                $matchedStudent = array_merge((array) $student, $matchedStudent);
                Institution_student::updateExaminationData($matchedStudent, $admissionInfo);
                $matchedStudent['id'] = $matchedStudent['student_id'];
                $this->updateStudentId($student, $matchedStudent);
            }
        }
    }

    /**
     * This function is implemented similar_text search algorithm 
     * to get the most matching name with the existing students
     * data set
     *
     * @param array $student
     * @return array
     */
    public function getMatchingStudents($student)
    {
        $sis_users = $this->student->getMatches($student);
        $studentData = [];
        if (!is_null($sis_users) && (count($sis_users) > 0)) {

The condition is_null($sis_users) is always false.

            $studentData = $this->searchSimilarName($student, $sis_users);
        }
        return $studentData;
    }

    /**
     * Search most matching name
     *
     * @param array $student
     * @param array $sis_students
     * @return array
     */
    public function searchSimilarName($student, $sis_students)
    {
        $highest = [];
        $previousValue = null;
        $matchedData = [];

        // search for matching name with last name
        foreach ($sis_students as $key => $value) {
            similar_text(get_l_name($student['f_name']), get_l_name($value['first_name']), $percentage);
            $value['rate'] = $percentage;

            if ($value['rate'] == 100) {
                $matchedData[] = $value;
            }

            if (($previousValue)) {
                $highest =  ($percentage > $previousValue['rate']) ? $value : $value;
            } else {
                $highest = $value;
            }
            $previousValue = $value;
        }

        //If the not matched 100% try to get most highest value with full name
        if ( ($highest['rate']  < 100) || (count($matchedData) > 1)) {
            foreach ($sis_students as $key => $value) {
                similar_text($student['f_name'], $value['first_name'], $percentage);
                $value['rate'] = $percentage;
                if (($previousValue)) {
                    $highest =  ($percentage > $previousValue['rate']) ? $value : $value;
                } else {
                    $highest = $value;
                }
                $previousValue = $value;
            }
        }
        return $highest;
    }

    /**
     * Generate new NSID for students
     *
     * @param array $student
     * @param array $sis_student
     * @return void
     */
    public function updateStudentId($student, $sis_student)
    {
        $student['nsid'] =  $sis_student['openemis_no'];
        // add new NSID to the examinations data set
        $this->examination_student->where(['st_no' => $student['st_no']])->update($student);
        $this->output->writeln('Updated ' . $sis_student['id'] . ' to NSID' . $sis_student['openemis_no']);
    }

    /**
     * export the all data with NSID
     *
     * @return void
     */
    public function export()
    {
        return Excel::download(new ExaminationStudentsExport, 'Students_data_with_nsid.csv');

The expression return Maatwebsite\Excel\Facades\Excel::download(new App\Exports\ExaminationStudentsExport(), 'Students_data_with_nsid.csv') returns the type Symfony\Component\HttpFoundation\BinaryFileResponse which is incompatible with the documented return type void.

    }
}