PGT storage on the filesystem

Collaboration diagram for PGT storage on the filesystem:

Namespaces
	PhpCAS

Functions
	CAS_PGTStorage_File::getPath ()
	This method returns the name of the directory where PGT's should be stored on the filesystem. More...
	CAS_PGTStorage_File::getStorageType ()
	This method returns an informational string giving the type of storage used by the object (used for debugging purposes). More...
	CAS_PGTStorage_File::getStorageInfo ()
	This method returns an informational string giving informations on the parameters of the storage. More...
	CAS_PGTStorage_File::__construct ($cas_parent, $path)
	The class constructor, called by CAS_Client::SetPGTStorageFile(). More...
	CAS_PGTStorage_File::init ()
	This method is used to initialize the storage. More...
	CAS_PGTStorage_File::getPGTIouFilename ($pgt_iou)
	This method returns the filename corresponding to a PGT Iou. More...
	CAS_PGTStorage_File::write ($pgt, $pgt_iou)
	This method stores a PGT and its corresponding PGT Iou into a file. More...
	CAS_PGTStorage_File::read ($pgt_iou)
	This method reads a PGT corresponding to a PGT Iou and deletes the corresponding file. More...

Variables
	CAS_PGTStorage_File::$_path
	a string telling where PGT's should be stored on the filesystem. More...

Detailed Description

Function Documentation

__construct()

CAS_PGTStorage_File::__construct	(		$cas_parent,
			$path
	)

The class constructor, called by CAS_Client::SetPGTStorageFile().

Parameters

CAS_Client	$cas_parent	the CAS_Client instance that creates the object.
string	$path	the path where the PGT's should be stored

Returns

void

Definition at line 115 of file File.php.

References $path, CAS_PGT_STORAGE_FILE_DEFAULT_PATH, phpCAS\error(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();
        // call the ancestor's constructor
        parent::__construct($cas_parent);

        if (empty($path)) {
            $path = CAS_PGT_STORAGE_FILE_DEFAULT_PATH;
        }
        // check that the path is an absolute path
        if (getenv("OS") == "Windows_NT") {
            if (!preg_match('`^[a-zA-Z]:`', $path)) {
                phpCAS::error('an absolute path is needed for PGT storage to file');
            }
        } else {
            if ($path[0] != '/') {
                phpCAS::error('an absolute path is needed for PGT storage to file');
            }

            // store the path (with a leading and trailing '/')
            $path = preg_replace('|[/]*$|', '/', $path);
            $path = preg_replace('|^[/]*|', '/', $path);
        }

        $this->_path = $path;
        phpCAS::traceEnd();
    }

Here is the call graph for this function:

getPath()

CAS_PGTStorage_File::getPath

(

)

This method returns the name of the directory where PGT's should be stored on the filesystem.

Returns

the name of a directory (with leading and trailing '/')

Definition at line 68 of file File.php.

References CAS_PGTStorage_File\$_path.

Referenced by CAS_PGTStorage_File\getPGTIouFilename(), and CAS_PGTStorage_File\getStorageInfo().

    {
        return $this->_path;
    }

Here is the caller graph for this function:

getPGTIouFilename()

CAS_PGTStorage_File::getPGTIouFilename

(

$pgt_iou

)

This method returns the filename corresponding to a PGT Iou.

Parameters

string

$pgt_iou

the PGT iou.

Returns

a filename

Definition at line 177 of file File.php.

References $filename, CAS_PGTStorage_File\getPath(), GuzzleHttp\Psr7\hash(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

Referenced by CAS_PGTStorage_File\read(), and CAS_PGTStorage_File\write().

    {
        phpCAS::traceBegin();
        $filename = $this->getPath() . "phpcas-" . hash("sha256", $pgt_iou);
//        $filename = $this->getPath().$pgt_iou.'.plain';
        phpCAS::trace("Sha256 filename:" . $filename);
        phpCAS::traceEnd();
        return $filename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStorageInfo()

CAS_PGTStorage_File::getStorageInfo

(

)

This method returns an informational string giving informations on the parameters of the storage.

(used for debugging purposes).

Returns

an informational string.

Definition at line 96 of file File.php.

References CAS_PGTStorage_File\getPath().

    {
        return 'path=`' . $this->getPath() . '\'';
    }

Here is the call graph for this function:

getStorageType()

CAS_PGTStorage_File::getStorageType

(

)

This method returns an informational string giving the type of storage used by the object (used for debugging purposes).

Returns

an informational string.

Definition at line 84 of file File.php.

    {
        return "file";
    }

init()

CAS_PGTStorage_File::init

(

)

This method is used to initialize the storage.

Halts on error.

Returns

void

Definition at line 153 of file File.php.

References init(), CAS_PGTStorage_AbstractStorage\isInitialized(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();
        // if the storage has already been initialized, return immediatly
        if ($this->isInitialized()) {
            return;
        }
        // call the ancestor's method (mark as initialized)
        parent::init();
        phpCAS::traceEnd();
    }

Here is the call graph for this function:

read()

CAS_PGTStorage_File::read

(

$pgt_iou

)

This method reads a PGT corresponding to a PGT Iou and deletes the corresponding file.

Parameters

string

$pgt_iou

the PGT iou

Returns

the corresponding PGT, or FALSE on error

Definition at line 231 of file File.php.

References $f, phpCAS\error(), CAS_PGTStorage_File\getPGTIouFilename(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();
        $pgt = false;
        $fname = $this->getPGTIouFilename($pgt_iou);
        if (file_exists($fname)) {
            if (!($f = fopen($fname, "r"))) {
                phpCAS::error('could not open `' . $fname . '\'');
            } else {
                if (($pgt = fgets($f)) === false) {
                    phpCAS::error('could not read PGT from `' . $fname . '\'');
                }
                phpCAS::trace('Successful read of PGT to `' . $fname . '\'');
                fclose($f);
            }
            // delete the PGT file
            @unlink($fname);
        } else {
            phpCAS::error('No such file `' . $fname . '\'');
        }
        phpCAS::traceEnd($pgt);
        return $pgt;
    }

Here is the call graph for this function:

write()

CAS_PGTStorage_File::write	(		$pgt,
			$pgt_iou
	)

This method stores a PGT and its corresponding PGT Iou into a file.

Echoes a warning on error.

Parameters

string	$pgt	the PGT
string	$pgt_iou	the PGT iou

Returns

void

Definition at line 198 of file File.php.

References $f, phpCAS\error(), CAS_PGTStorage_File\getPGTIouFilename(), phpCAS\trace(), phpCAS\traceBegin(), and phpCAS\traceEnd().

    {
        phpCAS::traceBegin();
        $fname = $this->getPGTIouFilename($pgt_iou);
        if (!file_exists($fname)) {
            touch($fname);
            // Chmod will fail on windows
            @chmod($fname, 0600);
            if ($f = fopen($fname, "w")) {
                if (fputs($f, $pgt) === false) {
                    phpCAS::error('could not write PGT to `' . $fname . '\'');
                }
                phpCAS::trace('Successful write of PGT to `' . $fname . '\'');
                fclose($f);
            } else {
                phpCAS::error('could not open `' . $fname . '\'');
            }
        } else {
            phpCAS::error('File exists: `' . $fname . '\'');
        }
        phpCAS::traceEnd();
    }

Here is the call graph for this function:

Variable Documentation

$_path

CAS_PGTStorage_File::$_path

a string telling where PGT's should be stored on the filesystem.

Written by PGTStorageFile::PGTStorageFile(), read by getPath().

Definition at line 58 of file File.php.

Referenced by CAS_PGTStorage_File\getPath().