Sunnysideup\UpgradeToSilverstripe4\Api\SessionManagement

Complexity

Total Complexity

17

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	deleteSession()	0	3	1
A	setSessionValue()	0	7	1
A	getSessionData()	0	13	3
A	setSessionFileLocation()	0	10	2
A	setSessionData()	0	25	6
A	getSessionValue()	0	7	2
A	getSessionFileLocation()	0	3	1
A	initSession()	0	6	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Api;

use Sunnysideup\UpgradeToSilverstripe4\Interfaces\SessionManagementInterface;
use Sunnysideup\UpgradeToSilverstripe4\Traits\Creator;

class SessionManagement implements SessionManagementInterface
{
    use Creator;

    protected $sessionFileLocation = '';

    public static function initSession(string $sessionFileLocation): SessionManagementInterface
    {
        $obj = self::create();
        $obj->setSessionFileLocation($sessionFileLocation);

It seems like setSessionFileLocation() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $obj;

The expression return $obj could return the type Sunnysideup\UpgradeToSilverstripe4\Traits\Creator which is incompatible with the type-hinted return Sunnysideup\UpgradeToSilverstripe4\Interfaces\SessionManagementInterface. Consider adding an additional type-check to rule them out.

    }

    public function setSessionFileLocation($sessionFileLocation): SessionManagementInterface
    {
        $this->sessionFileLocation = $sessionFileLocation;
        $link = $sessionFileLocation;
        $dir = dirname($link);
        if (! file_exists($dir)) {
            user_error('Could not find: ' . $dir);
        }

        return $this;
    }

    public function getSessionFileLocation(): string
    {
        return $this->sessionFileLocation;
    }

    public function deleteSession()
    {
        unlink($this->getSessionFileLocation());
    }

    public function getSessionValue(string $key): string
    {
        $session = $this->getSessionData();
        if (isset($session[$key])) {
            return $session[$key];
        }
        return '';
    }

    public function getSessionData(): array
    {
        if (file_exists($this->getSessionFileLocation())) {
            $data = file_get_contents($this->getSessionFileLocation()) ?? '{}';
            if (! $data) {
                user_error('Could not read from: ' . $this->getSessionFileLocation());
            }

            return json_decode($data, true);
        }
        $this->setSessionData([]);

        return $this->getSessionData();
    }

    public function setSessionData(array $session): SessionManagementInterface
    {
        if (! file_exists($this->getSessionFileLocation())) {
            $session['Started'] = date('Y-m-d h:i ');
        }
        $data = json_encode($session, JSON_PRETTY_PRINT);
        try {
            $file = fopen($this->getSessionFileLocation(), 'w');
            if ($file === false) {
                throw new \RuntimeException('Failed to open file: ' . $this->getSessionFileLocation());
            }
            $writeOutcome = fwrite($file, (string) $data);
            if ($writeOutcome === false) {
                throw new \RuntimeException('Failed to write file: ' . $this->getSessionFileLocation());
            }
            $closeOutcome = fclose($file);
            if ($closeOutcome === false) {
                throw new \RuntimeException('Failed to close file: ' . $this->getSessionFileLocation());
            }
        } catch (\Exception $e) {
            // send error message if you can
            echo 'Caught exception: ' . $e->getMessage() . ' location of file: ' . $this->getSessionFileLocation();
        }

        return $this;
    }

    public function setSessionValue(string $key, string $value): SessionManagementInterface
    {
        $session = $this->getSessionData();
        $session[$key] = trim($value);
        $this->setSessionData($session);

        return $this;
    }
}