Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/auth/cas/CAS/CAS/PGTStorage/ -> AbstractStorage.php (source)

[Source view]

Licensed to Jasig under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Jasig licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

Author: Pascal Aubry <pascal.aubry@univ-rennes1.fr>
License: http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
File Size: 222 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CAS_PGTStorage_AbstractStorage:: (9 methods):
  __construct()
  getStorageType()
  getStorageInfo()
  setErrorMessage()
  getErrorMessage()
  isInitialized()
  init()
  write()
  read()


Class: CAS_PGTStorage_AbstractStorage  - X-Ref

Basic class for PGT storage
The CAS_PGTStorage_AbstractStorage class is a generic class for PGT storage.
This class should not be instanciated itself but inherited by specific PGT
storage classes.

__construct($cas_parent)   X-Ref
The constructor of the class, should be called only by inherited classes.

param: CAS_Client $cas_parent the CAS _client instance that creates the
return: void

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

return: string

getStorageInfo()   X-Ref
This virtual method returns an informational string giving informations on the
parameters of the storage.(used for debugging purposes).

return: string

setErrorMessage($error_message)   X-Ref
This method sets en error message, which can be read later by
PGTStorage::getErrorMessage().

param: string $error_message an error message
return: void

getErrorMessage()   X-Ref
This method returns an error message set by PGTStorage::setErrorMessage().

return: string an error message when set by PGTStorage::setErrorMessage(), FALSE

isInitialized()   X-Ref
This method tells if the storage has already been intialized.

return: bool

init()   X-Ref
This virtual method initializes the object.

return: void

write($pgt,$pgt_iou)   X-Ref
This virtual method stores a PGT and its corresponding PGT Iuo.

param: string $pgt     the PGT
param: string $pgt_iou the PGT iou
return: void

read($pgt_iou)   X-Ref
This virtual method reads a PGT corresponding to a PGT Iou and deletes
the corresponding storage entry.

param: string $pgt_iou the PGT iou
return: string