diff --git a/lib/SimpleSAML/Bindings/SAML20/HTTPPost.php b/lib/SimpleSAML/Bindings/SAML20/HTTPPost.php index 31898338c437c3bf8f3bdd063e35111fd33a31e9..94af7f48f130097f8a140abda8bb0e5f46a2ae35 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 a372e6d3edd125d44eaab3f23340552e5aae8472..4fa8e7cbcfcf27d3f7d38184a37243cd6e05c6d7 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 f842e74607a7c8644d0a77e53470f0686f24de44..e9355a7b8bdf6be0e3c2847dbbacd7537912270f 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 49bc14a5187634e3b24741d34a1893c7165152f0..49035292dac4bc4e2c9b5c5c3d6282c51892ea4e 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 d6392d79893a5421d75305cb9db96475988888ff..e1bea16b6e76d9540baf5764be03745c8e6d8b55 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 ce3b51dbfd3ce3b6c468def3d9b07c560976186c..f8402086132dbfc5d2bad60f38ff173139aeb213 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 ab51591b9a3666de905daf3d4f423503283f9c6c..fd672aa12e2e0e2b3b4d4c3f7558271b67b91ec8 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 0547541368c2c0c02248b3714a8cd940b6893b23..b9affb918676b17b8cd1f28f9deb100aad7b29c4 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 f5376c440e33aa5516dfdb7f34fd71468cc38777..7a2a4be5698b6c11bf2b55bf0f64d6a7514de035 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 1ceb3696bf800eb8309b8c2a829f06a742e1c182..8feab8a6db9179703fb78346734686c67b8267bb 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 63b7a3f3a04af1aaac5ed7c498acb386cce149ca..f4e69f5c4eca6b8fd1762c92e0ea18f188d216ac 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 625435a1669a37a80b43ecc6a7cf741c47f04f7b..039835b2b2407916dcb3e5430799b8735b23f48f 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 132918662f210baa031b8c5301ea09d3a2c20b1f..1466e0e2ec2dd2290846736bf6b07e2f41150619 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 b4c26510e9a53f0d1915c6e71f2860c831280ad8..e177b4b642c45f88f999d30acb15ca3e3a836ace 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 e558e55315447e92e1b3ca739575c00bc690a61b..bb50bd7e052997371ff5285f001db3788d8810d8 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 6ce5599aeedae4c14e883a69381c797eaa1ef188..23b1ea2d7a7da0843bfbd9a848acd077e94895ff 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 82ce7ada15bc70ae49105d31bd2c87432493d468..52bb98cf98815ea840a07e1014ace4428cb83640 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 dd595a2460930cbe471bc7489e666c14ce61dd7f..974ce533ba5621d6cddd3bbe78583b6a26a8c5c1 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 80fe4b0bb2581926f35c68243e61607a1ac99241..13ae8170b76a1d0f26b7c9531a53ccc4922b8618 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 0feeeafd3050c073fecef29e7cb2850a8f504f07..38f0b7fc8ea5a50b516d72b34aac51eb45b8fba7 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 {