Source.php

<?php

namespace Stanford\MirrorSourceDataModule;

use REDCap;

/**
 * Class Source
 * @package Stanford\MirrorSourceDataModule
 * @property int $projectId
 * @property \Project $project
 * @property int $eventId
 * @property array $dags
 * @property array $record
 * @property string $recordId
 * @property string $instrument
 * @property string $eventName
 * @property string $primaryKey
 * @property string $PREFIX
 * @property array $migrationFields
 * @property boolean $updateNotes
 * @property string $surveyField
 *
 */
class Source
{

    use emLoggerTrait;

    private $projectId;

    private $project;

    private $eventId;

    private $dags;

    private $record;

    private $recordId;

    private $instrument;

    private $eventName;

    private $primaryKey;

    public $PREFIX;

    private $surveyField;
    /**
     * if source is mirroring to multiple destination projects. when changing destination object check if want to update the notes for source based on previous destination status
     * @var
     */
    public $canUpdateNotes;

    private $migrationFields;
    /**
     * Source constructor.
     * @param $projectId
     * @param $eventId
     * @param null $recordId
     * @param null $instrument
     * @param null $dags
     */
    public function __construct($projectId, $eventId, $prefix, $recordId = null, $instrument = null, $dags = null)
    {
        $this->setProjectId($projectId);

        $this->setEventId($eventId);

        $this->setEventName(\REDCap::getEventNames(true, true, $this->getEventId()));

        $this->setProject(new \Project($this->getProjectId()));

        $this->setPrimaryKey($this->getProject()->table_pk);
        if (!is_null($recordId)) {
            $this->setRecordId($recordId);
        }

        if (!is_null($instrument)) {
            $this->setInstrument($instrument);
        }

        if (!is_null($dags)) {
            $this->setDags($dags);
        }

        /**
         * this public so we do not have to modify emLoggerTrait
         */
        $this->PREFIX = $prefix;
    }

    /**
     * Bubble up status to user via the timestamp and notes field in the source form
     * in config file as 'migration-notes'
     * @param $config : config fields for migration module
     * @param $msg : Message to enter into Notes field
     * @param $source_data : If destination migration successful, data about migration to destination (else leave as null)
     * @return bool        : return fail/pass status of save data
     */
    public function updateNotes($config, $msg, $source_data = array())
    {
        //$this->emLog($source_data, "DEBUG", "RECEIVED THIS DATA");
        $source_data[$this->getPrimaryKey()] = $this->getRecordId();
        if (isset($config['migration-notes'])) {
            $source_data[$config['migration-notes']] = $msg;
        }

        // Don't overwrite the redirect url if it was just set!
        if(!empty($config['field-to-save-destination-survey-url'])) {
            unset($source_data[$config['field-to-save-destination-survey-url']]);
        }

        if (!empty($config['source-event-name'])) {
            //assuming that current event is the right event
            //$this->emLog("Event name from REDCap::getEventNames : $source_event / EVENT name from this->redcap_event_name: ".$this->redcap_event_name);
            $source_data['redcap_event_name'] = $this->getEventName(); //$config['source-event-name'];
        }

        /**
        //This works, why is change broken?
        $this->emLog($source_data, "Saving Source Data");
        $result = REDCap::saveData(
        $this->getProjectId(),
        'json',
        json_encode(array($source_data)),
        'overwrite');
         *
         */

        $params = [
            "project_id" => $this->getProject(),
            "dataFormat" => 'json',
            "data" => json_encode(array($source_data)),
            "overwriteBehavior" => 'overwrite'
        ];
        $result = REDCap::saveData($params);
        //$this->emLog($source_data, "Saving Source Data");

        // Check for upload errors
        if (!empty($result['errors'])) {
            $msg = "Error creating record in SOURCE project " . $this->getProjectId() . " - ask administrator to review logs: " . json_encode($result) . " - " . json_encode($params);
            //$sr->updateFinalReviewNotes($msg);
            //todo: bubble up to user : should this be sent to logging?
            $this->emError($msg);
//            $this->emError("RESULT OF SOURCE: " . print_r($result, true));
            $this->emError("RESULT OF SOURCE: ");
            //logEvent($description, $changes_made="", $sql="", $record=null, $event_id=null, $project_id=null);
            REDCap::logEvent("Mirror Source Data Module", $msg, null, $this->getRecordId(),
                $config['source-event-name']);
            return false;
        }

    }

    public function saveSurveyURL($config, $link)
    {
        if (!$this->getSurveyField()) {
            $this->updateNotes($config,
                'Destination survey option is defined but no field in source defined to save the survey url. ');
        } else {
            $data[$this->getSurveyField()] = $link;
            $data[REDCap::getRecordIdField()] = $this->getRecordId();
//            $this->emLog($data, "Saving Source Survey Link");
            $this->emLog("Saving Source Survey Link");
            $result = REDCap::saveData(
                $this->getProjectId(),
                'json',
                json_encode(array($data)),
                'overwrite');

            // Check for upload errors
            if (!empty($result['errors'])) {
                $this->updateNotes($config,
                    'Destination survey option is defined but no field in source defined to save the survey url. ');
                return false;
            }
        }
    }

    /**
     * @return array
     */
    public function getMigrationFields()
    {
        return $this->migrationFields;
    }

    /**
     * based on configuration find out the field will be migrated from source project into destination project
     * @param $config
     * @param \Stanford\MirrorSourceDataModule\Destination $destination
     */
    public function setMigrationFields($config, $destination)
    {

        $arrFields = array();
        //branching logic reset does not clear out old values - force clear here
        switch ($config['fields-to-migrate']) {
            case 'migrate-intersect':
                //get source instrument for current event
                $sourceFields = $this->getProjectFields($this);

                $destinationFields = $this->getProjectFields($destination);

                $arrFields = array_intersect($sourceFields, $destinationFields);
                break;
            case 'migrate-intersect-specified':
                //get source instrument for current event
                $sourceFields = $this->getProjectFields($this);

                $destinationFields = $this->getProjectFields($destination);

                //get all fields
                $arrFields = array_intersect($sourceFields, $destinationFields);

                //intersect with included only.
                $arrFields = array_intersect($arrFields, $config['include-only-fields']);

                break;
            case 'migrate-destination-form':
                $sourceFields = array_keys($destination->getProject()->forms[$config['include-only-form-destination']]['fields']);
                //remove last field which is complete because its does not exist in the destination project
                $sourceFields = $this->removeLastField($sourceFields);


                $destinationFields = $this->getProjectFields($destination);

                $arrFields = array_intersect($sourceFields, $destinationFields);
                break;
            case 'migrate-source-form':
                $sourceFields = array_keys($this->getProject()->forms[$config['include-only-form-source']]['fields']);
                //remove last field which is complete because its does not exist in the source project
                $sourceFields = $this->removeLastField($sourceFields);

                $destinationFields = $this->getProjectFields($destination);

                $arrFields = array_intersect($sourceFields, $destinationFields);
                break;
        }


        //lastly remove exclude fields if specified
        if (count($config['exclude-fields']?:[]) > 0) {
            $arrFields = $this->removeExcludedFields($arrFields, $config);
        }

        $this->migrationFields = $arrFields;

    }


    /**
     * @param $arrFields
     * @param $config
     * @return mixed
     */
    private function removeExcludedFields($arrFields, $config)
    {
        $diff = array_intersect($config['exclude-fields'], $arrFields);
        foreach ($diff as $element) {
            $key = array_search($element, $arrFields);
            if ($key) {
                unset($arrFields[$key]);
            }
        }
        reset($arrFields);
        //$this->emDebug($arrFields, 'EXCLUDED arr_fields:');
        return $arrFields;
    }

    /**
     * @param Source | Destination $project
     */
    private function getProjectFields($project)
    {
        /**
         * if event is defined use it otherwise use first event ID
         */
        if ($project->getEventId()) {
            $instruments = $project->getProject()->eventsForms[$project->getEventId()];
        } else {
            $instruments = current($project->getProject()->eventsForms);
        }

        $result = array();
        foreach ($instruments as $instrument) {
            $fields = array_keys($project->getProject()->forms[$instrument]['fields']);
            if (empty($result)) {
                $result = $fields;
            } else {
                $result = array_merge($result, $fields);
            }
        }
        return $result;
    }

    /**
     * @param $fields
     * @return mixed
     */
    private function removeLastField($fields)
    {
        $length = count($fields) - 1;
        unset($fields[$length]);
        return $fields;
    }
    /**
     * @return int
     */
    public function getProjectId()
    {
        return $this->projectId;
    }

    /**
     * @param int $projectId
     */
    public function setProjectId($projectId)
    {
        $this->projectId = $projectId;
    }

    /**
     * @return \Project
     */
    public function getProject()
    {
        return $this->project;
    }

    /**
     * @param \Project $project
     */
    public function setProject($project)
    {
        $this->project = $project;
    }

    /**
     * @return int
     */
    public function getEventId()
    {
        return $this->eventId;
    }

    /**
     * @param int $eventId
     */
    public function setEventId($eventId)
    {
        $this->eventId = $eventId;
    }

    /**
     * @return array
     */
    public function getDags()
    {
        return $this->dags;
    }

    /**
     * @param array $dags
     */
    public function setDags($dags)
    {
        $this->dags = $dags;
    }


    /**
     * @return array
     */
    public function resetRecord()
    {
        $this->record = null;
    }

    /**
     * @return array
     */
    public function getRecord()
    {
        if ($this->record) {
            return $this->record;
        } else {
            $this->setRecord();
            return $this->record;
        }

    }

    /**
     * @param array $record
     */
    public function setRecord()
    {
        //4. Get data from source to be saved on destination
        //set source record based on selected fields
        $results = REDCap::getData('json', $this->getRecordId(), $this->getMigrationFields(),
            $this->getEventName());
        $results = json_decode($results, true);
        $this->record = end($results);
    }

    /**
     * @return string
     */
    public function getRecordId()
    {
        return $this->recordId;
    }

    /**
     * @param string $recordId
     */
    public function setRecordId($recordId)
    {
        $this->recordId = $recordId;
    }

    /**
     * @return string
     */
    public function getInstrument()
    {
        return $this->instrument;
    }

    /**
     * @param string $instrument
     */
    public function setInstrument($instrument)
    {
        $this->instrument = $instrument;
    }

    /**
     * @return string
     */
    public function getEventName()
    {
        return $this->eventName;
    }

    /**
     * @param string $eventName
     */
    public function setEventName($eventName)
    {
        $this->eventName = $eventName;
    }

    /**
     * @return string
     */
    public function getPrimaryKey()
    {
        return $this->primaryKey;
    }

    /**
     * @param string $primaryKey
     */
    public function setPrimaryKey($primaryKey)
    {
        $this->primaryKey = $primaryKey;
    }

    /**
     * @return string
     */
    public function getSurveyField()
    {
        return $this->surveyField;
    }

    /**
     * @param string $surveyField
     */
    public function setSurveyField($surveyField)
    {
        $this->surveyField = $surveyField;
    }


}