From 1cf605604cd7c53ae9eb53818483991494be6f83 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20=C3=85kre=20Solberg?= <andreas.solberg@uninett.no>
Date: Wed, 30 Jan 2008 11:10:10 +0000
Subject: [PATCH] Setting file properties in svn metadata. Adding header in all
library php files with version etc.
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@222 44740490-163a-0410-bde0-09ae8108e29a
---
lib/SimpleSAML/Bindings/SAML20/HTTPPost.php | 17 +++++----------
.../Bindings/SAML20/HTTPRedirect.php | 17 +++++----------
lib/SimpleSAML/Bindings/Shib13/HTTPPost.php | 18 +++++-----------
lib/SimpleSAML/Configuration.php | 15 ++++---------
lib/SimpleSAML/Logger.php | 14 +++++--------
lib/SimpleSAML/MemcacheStore.php | 12 ++++++-----
.../Metadata/MetaDataStorageHandler.php | 21 ++++++++-----------
.../MetaDataStorageHandlerFlatfile.php | 17 +++++++--------
.../MetaDataStorageHandlerSAML2Meta.php | 17 +++++++--------
lib/SimpleSAML/SessionHandler.php | 14 +++++++------
lib/SimpleSAML/SessionHandlerCookie.php | 15 +++++++------
lib/SimpleSAML/SessionHandlerMemcache.php | 20 ++++++++++--------
lib/SimpleSAML/SessionHandlerPHP.php | 7 +++++--
lib/SimpleSAML/Utilities.php | 17 +++++----------
lib/SimpleSAML/XHTML/Template.php | 15 +++++--------
lib/SimpleSAML/XML/AttributeFilter.php | 14 ++++---------
lib/SimpleSAML/XML/Parser.php | 15 ++++---------
lib/SimpleSAML/XML/SAML20/LogoutRequest.php | 15 +++++--------
lib/SimpleSAML/XML/SAML20/LogoutResponse.php | 17 +++++----------
lib/SimpleSAML/XML/Validator.php | 4 ++++
20 files changed, 119 insertions(+), 182 deletions(-)
diff --git a/lib/SimpleSAML/Bindings/SAML20/HTTPPost.php b/lib/SimpleSAML/Bindings/SAML20/HTTPPost.php
index 31898338c..94af7f48f 100644
--- a/lib/SimpleSAML/Bindings/SAML20/HTTPPost.php
+++ b/lib/SimpleSAML/Bindings/SAML20/HTTPPost.php
@@ -1,16 +1,5 @@
<?php
-
-/**
- * SimpleSAMLphp
- *
- * PHP versions 4 and 5
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Metadata/MetaDataStorageHandler.php');
@@ -19,7 +8,11 @@ require_once('SimpleSAML/XHTML/Template.php');
/**
- * Configuration of SimpleSAMLphp
+ * Implementation of the SAML 2.0 HTTP-POST binding.
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_Bindings_SAML20_HTTPPost {
diff --git a/lib/SimpleSAML/Bindings/SAML20/HTTPRedirect.php b/lib/SimpleSAML/Bindings/SAML20/HTTPRedirect.php
index a372e6d3e..4fa8e7cbc 100644
--- a/lib/SimpleSAML/Bindings/SAML20/HTTPRedirect.php
+++ b/lib/SimpleSAML/Bindings/SAML20/HTTPRedirect.php
@@ -1,16 +1,5 @@
<?php
-
-/**
- * SimpleSAMLphp
- *
- * PHP versions 4 and 5
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Utilities.php');
require_once('SimpleSAML/Metadata/MetaDataStorageHandler.php');
@@ -18,7 +7,11 @@ require_once('SimpleSAML/XHTML/Template.php');
require_once('xmlseclibs.php');
/**
- * Configuration of SimpleSAMLphp
+ * Implementation of the SAML 2.0 HTTP-REDIRECT binding.
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_Bindings_SAML20_HTTPRedirect {
diff --git a/lib/SimpleSAML/Bindings/Shib13/HTTPPost.php b/lib/SimpleSAML/Bindings/Shib13/HTTPPost.php
index f842e7460..e9355a7b8 100644
--- a/lib/SimpleSAML/Bindings/Shib13/HTTPPost.php
+++ b/lib/SimpleSAML/Bindings/Shib13/HTTPPost.php
@@ -1,23 +1,15 @@
<?php
-
-/**
- * SimpleSAMLphp
- *
- * PHP versions 4 and 5
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Metadata/MetaDataStorageHandler.php');
-
require_once('SimpleSAML/XML/Shib13/AuthnResponse.php');
/**
- * Configuration of SimpleSAMLphp
+ * Implementation of the Shibboleth 1.3 HTTP-POST binding.
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_Bindings_Shib13_HTTPPost {
diff --git a/lib/SimpleSAML/Configuration.php b/lib/SimpleSAML/Configuration.php
index 49bc14a51..49035292d 100644
--- a/lib/SimpleSAML/Configuration.php
+++ b/lib/SimpleSAML/Configuration.php
@@ -1,18 +1,11 @@
<?php
-
-
-/**
- * SimpleSAMLphp
- *
- * PHP versions 4 and 5
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
/**
* Configuration of SimpleSAMLphp
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_Configuration {
diff --git a/lib/SimpleSAML/Logger.php b/lib/SimpleSAML/Logger.php
index d6392d798..e1bea16b6 100644
--- a/lib/SimpleSAML/Logger.php
+++ b/lib/SimpleSAML/Logger.php
@@ -1,18 +1,14 @@
<?php
-/**
- * SimpleSAMLphp
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Session.php');
/**
- * A logger class.
+ * A class for logging
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $ID$
*/
class SimpleSAML_Logger {
diff --git a/lib/SimpleSAML/MemcacheStore.php b/lib/SimpleSAML/MemcacheStore.php
index ce3b51dbf..f84020861 100644
--- a/lib/SimpleSAML/MemcacheStore.php
+++ b/lib/SimpleSAML/MemcacheStore.php
@@ -1,5 +1,8 @@
<?
+/* We need access to the configuration from config/config.php. */
+require_once('SimpleSAML/Configuration.php');
+
/*
* This file is part of SimpleSAMLphp. See the file COPYING in the
* root of the distribution for licence information.
@@ -15,12 +18,11 @@
* For this code to work correctly, all web servers accessing the data must
* have the same clock (as measured by the time()-function). Different clock
* values will lead to incorrect behaviour.
+ *
+ * @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
-
-/* We need access to the configuration from config/config.php. */
-require_once('SimpleSAML/Configuration.php');
-
-
class SimpleSAML_MemcacheStore {
diff --git a/lib/SimpleSAML/Metadata/MetaDataStorageHandler.php b/lib/SimpleSAML/Metadata/MetaDataStorageHandler.php
index ab51591b9..fd672aa12 100644
--- a/lib/SimpleSAML/Metadata/MetaDataStorageHandler.php
+++ b/lib/SimpleSAML/Metadata/MetaDataStorageHandler.php
@@ -1,21 +1,18 @@
<?php
-/*
- * This file is part of simpleSAMLphp. See the file COPYING in the
- * root of the distribution for licence information.
- *
- * This file defines a base class for metadata handling.
- * Instantiation of session handler objects should be done through
- * the class method getMetadataHandler().
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Utilities.php');
/**
- * Configuration of SimpleSAMLphp
- */
-abstract class SimpleSAML_Metadata_MetaDataStorageHandler {
+ * This file defines a base class for metadata handling.
+ * Instantiation of session handler objects should be done through
+ * the class method getMetadataHandler().
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
+ */
+ class SimpleSAML_Metadata_MetaDataStorageHandler {
protected $metadata = null;
diff --git a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerFlatfile.php b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerFlatfile.php
index 054754136..b9affb918 100644
--- a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerFlatfile.php
+++ b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerFlatfile.php
@@ -1,20 +1,17 @@
<?php
-/*
- * This file is part of simpleSAMLphp. See the file COPYING in the
- * root of the distribution for licence information.
- *
- * This file defines a base class for metadata handling.
- * Instantiation of session handler objects should be done through
- * the class method getMetadataHandler().
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Utilities.php');
require_once('SimpleSAML/Metadata/MetaDataStorageHandler.php');
/**
- * Configuration of SimpleSAMLphp
+ * This file defines a flat file metadata handler.
+ * Instantiation of session handler objects should be done through
+ * the class method getMetadataHandler().
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile extends SimpleSAML_Metadata_MetaDataStorageHandler {
diff --git a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSAML2Meta.php b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSAML2Meta.php
index f5376c440..7a2a4be56 100644
--- a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSAML2Meta.php
+++ b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSAML2Meta.php
@@ -1,14 +1,5 @@
<?php
-/*
- * This file is part of simpleSAMLphp. See the file COPYING in the
- * root of the distribution for licence information.
- *
- * This file defines a base class for metadata handling.
- * Instantiation of session handler objects should be done through
- * the class method getMetadataHandler().
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Utilities.php');
require_once('SimpleSAML/XML/Parser.php');
@@ -16,7 +7,13 @@ require_once('SimpleSAML/Metadata/MetaDataStorageHandler.php');
require_once('SimpleSAML/Logger.php');
/**
- * Configuration of SimpleSAMLphp
+ * This file defines a SAML 2.0 XML metadata handler.
+ * Instantiation of session handler objects should be done through
+ * the class method getMetadataHandler().
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_Metadata_MetaDataStorageHandlerSAML2Meta extends SimpleSAML_Metadata_MetaDataStorageHandler {
diff --git a/lib/SimpleSAML/SessionHandler.php b/lib/SimpleSAML/SessionHandler.php
index 1ceb3696b..8feab8a6d 100644
--- a/lib/SimpleSAML/SessionHandler.php
+++ b/lib/SimpleSAML/SessionHandler.php
@@ -1,18 +1,20 @@
<?php
-/*
+/* We need access to the configuration from config/config.php. */
+require_once('SimpleSAML/Configuration.php');
+
+/**
* This file is part of SimpleSAMLphp. See the file COPYING in the
* root of the distribution for licence information.
*
* This file defines a base class for session handling.
* Instantiation of session handler objects should be done through
* the class method getSessionHandler().
+ *
+ * @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
-
-/* We need access to the configuration from config/config.php. */
-require_once('SimpleSAML/Configuration.php');
-
-
abstract class SimpleSAML_SessionHandler {
diff --git a/lib/SimpleSAML/SessionHandlerCookie.php b/lib/SimpleSAML/SessionHandlerCookie.php
index 63b7a3f3a..f4e69f5c4 100644
--- a/lib/SimpleSAML/SessionHandlerCookie.php
+++ b/lib/SimpleSAML/SessionHandlerCookie.php
@@ -1,18 +1,21 @@
<?php
-/*
+/* We need access to the configuration from config/config.php. */
+require_once('SimpleSAML/Configuration.php');
+
+/**
* This file is part of SimpleSAMLphp. See the file COPYING in the
* root of the distribution for licence information.
*
* This file defines a base class for session handlers that need to store
* the session id in a cookie. It takes care of storing and retrieving the
* session id.
+ *
+ * @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @abstract
+ * @version $Id$
*/
-
-/* We need access to the configuration from config/config.php. */
-require_once('SimpleSAML/Configuration.php');
-
-
abstract class SimpleSAML_SessionHandlerCookie
extends SimpleSAML_SessionHandler {
diff --git a/lib/SimpleSAML/SessionHandlerMemcache.php b/lib/SimpleSAML/SessionHandlerMemcache.php
index 625435a16..039835b2b 100644
--- a/lib/SimpleSAML/SessionHandlerMemcache.php
+++ b/lib/SimpleSAML/SessionHandlerMemcache.php
@@ -1,13 +1,5 @@
<?php
-/*
- * This file is part of SimpleSAMLphp. See the file COPYING in the
- * root of the distribution for licence information.
- *
- * This file defines a session handler which uses the MemcacheStore
- * class to store data in memcache servers.
- */
-
/* We use the MemcacheStore class to store session information. */
require_once('SimpleSAML/MemcacheStore.php');
@@ -16,7 +8,17 @@ require_once('SimpleSAML/MemcacheStore.php');
*/
require_once('SimpleSAML/SessionHandlerCookie.php');
-
+/**
+ * This file is part of SimpleSAMLphp. See the file COPYING in the
+ * root of the distribution for licence information.
+ *
+ * This file defines a session handler which uses the MemcacheStore
+ * class to store data in memcache servers.
+ *
+ * @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
+ */
class SimpleSAML_SessionHandlerMemcache
extends SimpleSAML_SessionHandlerCookie {
diff --git a/lib/SimpleSAML/SessionHandlerPHP.php b/lib/SimpleSAML/SessionHandlerPHP.php
index 132918662..1466e0e2e 100644
--- a/lib/SimpleSAML/SessionHandlerPHP.php
+++ b/lib/SimpleSAML/SessionHandlerPHP.php
@@ -1,13 +1,16 @@
<?php
-/*
+/**
* This file is part of SimpleSAMLphp. See the file COPYING in the
* root of the distribution for licence information.
*
* This file defines a session handler which uses the default php
* session handler for storage.
+ *
+ * @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
-
class SimpleSAML_SessionHandlerPHP extends SimpleSAML_SessionHandler {
/* Initialize the PHP session handling. This constructor is protected
diff --git a/lib/SimpleSAML/Utilities.php b/lib/SimpleSAML/Utilities.php
index b4c26510e..e177b4b64 100644
--- a/lib/SimpleSAML/Utilities.php
+++ b/lib/SimpleSAML/Utilities.php
@@ -1,21 +1,14 @@
<?php
-
-/**
- * SimpleSAMLphp
- *
- * PHP versions 4 and 5
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/XHTML/Template.php');
/**
- * Configuration of SimpleSAMLphp
+ * Misc static functions that is used several places.in example parsing and id generation.
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_Utilities {
diff --git a/lib/SimpleSAML/XHTML/Template.php b/lib/SimpleSAML/XHTML/Template.php
index e558e5531..bb50bd7e0 100644
--- a/lib/SimpleSAML/XHTML/Template.php
+++ b/lib/SimpleSAML/XHTML/Template.php
@@ -1,18 +1,13 @@
<?php
-
-/**
- * simpleSAMLphp
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
require_once('SimpleSAML/Configuration.php');
/**
- * Configuration of SimpleSAMLphp
+ * A minimalistic XHTML PHP based template system implemented for simpleSAMLphp.
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_XHTML_Template {
diff --git a/lib/SimpleSAML/XML/AttributeFilter.php b/lib/SimpleSAML/XML/AttributeFilter.php
index 6ce5599ae..23b1ea2d7 100644
--- a/lib/SimpleSAML/XML/AttributeFilter.php
+++ b/lib/SimpleSAML/XML/AttributeFilter.php
@@ -1,19 +1,13 @@
<?php
+require_once('SimpleSAML/Configuration.php');
/**
- * SimpleSAMLphp
- *
- * LICENSE: See the COPYING file included in this distribution.
+ * AttributeFilter is a mapping between attribute names.
*
* @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
-require_once('SimpleSAML/Configuration.php');
-//require_once('SimpleSAML/Utilities.php');
-
-/**
- * Configuration of SimpleSAMLphp
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_XML_AttributeFilter {
diff --git a/lib/SimpleSAML/XML/Parser.php b/lib/SimpleSAML/XML/Parser.php
index 82ce7ada1..52bb98cf9 100644
--- a/lib/SimpleSAML/XML/Parser.php
+++ b/lib/SimpleSAML/XML/Parser.php
@@ -1,18 +1,11 @@
<?php
-/*
- * This file is part of simpleSAMLphp. See the file COPYING in the
- * root of the distribution for licence information.
- *
- * This file will help doing XPath queries in SAML 2 XML documents.
- */
-
-
/**
- * Configuration of SimpleSAMLphp
+ * This file will help doing XPath queries in SAML 2 XML documents.
*
- * This class should be extending SimpleXMLElement, but it is not because of some bugs:
- * http://bugs.php.net/bug.php?id=32188&edit=1
+ * @author Andreas Ă…kre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_XML_Parser {
diff --git a/lib/SimpleSAML/XML/SAML20/LogoutRequest.php b/lib/SimpleSAML/XML/SAML20/LogoutRequest.php
index dd595a246..974ce533b 100644
--- a/lib/SimpleSAML/XML/SAML20/LogoutRequest.php
+++ b/lib/SimpleSAML/XML/SAML20/LogoutRequest.php
@@ -1,19 +1,14 @@
<?php
-
-/**
- * SimpleSAMLphp
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Metadata/MetaDataStorageHandler.php');
/**
- * Configuration of SimpleSAMLphp
+ * Implementation of the SAML 2.0 LogoutRequest message.
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_XML_SAML20_LogoutRequest {
diff --git a/lib/SimpleSAML/XML/SAML20/LogoutResponse.php b/lib/SimpleSAML/XML/SAML20/LogoutResponse.php
index 80fe4b0bb..13ae8170b 100644
--- a/lib/SimpleSAML/XML/SAML20/LogoutResponse.php
+++ b/lib/SimpleSAML/XML/SAML20/LogoutResponse.php
@@ -1,16 +1,5 @@
<?php
-
-/**
- * SimpleSAMLphp
- *
- * PHP versions 4 and 5
- *
- * LICENSE: See the COPYING file included in this distribution.
- *
- * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
- */
-
require_once('SimpleSAML/Configuration.php');
require_once('SimpleSAML/Session.php');
require_once('SimpleSAML/Utilities.php');
@@ -19,7 +8,11 @@ require_once('SimpleSAML/Metadata/MetaDataStorageHandler.php');
require_once('xmlseclibs.php');
/**
- * Configuration of SimpleSAMLphp
+ * Implementation of the SAML 2.0 LogoutResponse message.
+ *
+ * @author Andreas Ĺkre Solberg, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_XML_SAML20_LogoutResponse {
diff --git a/lib/SimpleSAML/XML/Validator.php b/lib/SimpleSAML/XML/Validator.php
index 0feeeafd3..38f0b7fc8 100644
--- a/lib/SimpleSAML/XML/Validator.php
+++ b/lib/SimpleSAML/XML/Validator.php
@@ -2,6 +2,10 @@
/**
* This class implements helper functions for XML validation.
+ *
+ * @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no>
+ * @package simpleSAMLphp
+ * @version $Id$
*/
class SimpleSAML_XML_Validator {
--
GitLab