Class CAS_PGTStorage_File

The CAS_PGTStorage_File class is a class for PGT file storage. An instance of this class is returned by CAS_Client::SetPGTStorageFile().

CAS_PGTStorage_AbstractStorage

CAS_PGTStorage_File

Package: PhpCAS
Category: Authentication
License: Apache License 2.0
Author: Pascal Aubry pascal.aubry@univ-rennes1.fr
Link: https://wiki.jasig.org/display/CASC/phpCAS
Class: CAS_PGTStorage_File
Ingroup: internalPGTStorageFile
Located at shared/cas/source/CAS/PGTStorage/File.php

Methods summary
`public the`	# `getPath( )` This method returns the name of the directory where PGT's should be stored on the filesystem. 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 '/') Private
`public an`	# `getStorageType( )` This method returns an informational string giving the type of storage used by the object (used for debugging purposes). This method returns an informational string giving the type of storage used by the object (used for debugging purposes). Returns an informational string. Public Overrides `CAS_PGTStorage_AbstractStorage::getStorageType()`
`public an`	# `getStorageInfo( )` This method returns an informational string giving informations on the parameters of the storage.(used for debugging purposes). This method returns an informational string giving informations on the parameters of the storage.(used for debugging purposes). Returns an informational string. Public Overrides `CAS_PGTStorage_AbstractStorage::getStorageInfo()`
`public`	# `__construct( CAS_Client $cas_parent, string $path )` The class constructor, called by CAS_Client::SetPGTStorageFile(). The class constructor, called by CAS_Client::SetPGTStorageFile(). Parameters `$cas_parent` the CAS_Client instance that creates the object. `$path` the path where the PGT's should be stored Public Overrides `CAS_PGTStorage_AbstractStorage::__construct()`
`public`	# `init( )` This method is used to initialize the storage. Halts on error. This method is used to initialize the storage. Halts on error. Public Overrides `CAS_PGTStorage_AbstractStorage::init()`
`public a`	# `getPGTIouFilename( string $pgt_iou )` This method returns the filename corresponding to a PGT Iou. This method returns the filename corresponding to a PGT Iou. Parameters `$pgt_iou` the PGT iou. Returns a filename Private
`public`	# `write( string $pgt, string $pgt_iou )` This method stores a PGT and its corresponding PGT Iou into a file. Echoes a warning on error. This method stores a PGT and its corresponding PGT Iou into a file. Echoes a warning on error. Parameters `$pgt` the PGT `$pgt_iou` the PGT iou Public Overrides `CAS_PGTStorage_AbstractStorage::write()`
`public the`	# `read( string $pgt_iou )` This method reads a PGT corresponding to a PGT Iou and deletes the corresponding file. This method reads a PGT corresponding to a PGT Iou and deletes the corresponding file. Parameters `$pgt_iou` the PGT iou Returns the corresponding PGT, or FALSE on error Public Overrides `CAS_PGTStorage_AbstractStorage::read()`

Methods inherited from CAS_PGTStorage_AbstractStorage
`getErrorMessage(), isInitialized(), setErrorMessage()`

Properties summary
`public`	`$_path` a string telling where PGT's should be stored on the filesystem. Written by PGTStorageFile::PGTStorageFile(), read by getPath(). a string telling where PGT's should be stored on the filesystem. Written by PGTStorageFile::PGTStorageFile(), read by getPath(). Private	#

Properties inherited from CAS_PGTStorage_AbstractStorage
`$_error_message, $_initialized`

class-CAS_PGTStorage_File

Namespaces

Classes

Interfaces

Exceptions

Functions

Class CAS_PGTStorage_File

Returns

Private

Returns

Public

Overrides

Returns

Public

Overrides

Parameters

Public

Overrides

Public

Overrides

Parameters

Returns

Private

Parameters

Public

Overrides

Parameters

Returns

Public

Overrides

Private