diff --git a/docs/simplesamlphp-maintenance.md b/docs/simplesamlphp-maintenance.md index 8c209672f88f1ecc7480a5121005553b3d390958..23a373ee8b65dfa32b8382496a751912e8ef2d9e 100644 --- a/docs/simplesamlphp-maintenance.md +++ b/docs/simplesamlphp-maintenance.md @@ -1,21 +1,14 @@ # SimpleSAMLphp Maintenance -<!-- - This file is written in Markdown syntax. - For more information about how to use the Markdown syntax, read here: - http://daringfireball.net/projects/markdown/syntax ---> - [TOC] ## SimpleSAMLphp news and documentation Please check the following sources of information to stay up to date with regard to SimpleSAMLphp: -* [SimpleSAMLphp documentation](http://simplesamlphp.org/docs) +* [SimpleSAMLphp documentation](https://simplesamlphp.org/docs) * [SimpleSAMLphp homepage](https://simplesamlphp.org) * [SimpleSAMLphp mailing lists](https://simplesamlphp.org/lists) -* [SimpleSAMLphp in twitter](https://twitter.com/simplesamlphp) ## Session management @@ -220,7 +213,7 @@ example configuration of different metadata sources in use at the same time: You may also implement your own metadata storage handler, in a very similar way to how you would implement your own session handler. Your class **must** extend the `\SimpleSAML\Metadata\MetaDataStorageSource` class and override the methods needed to change the backend used. This class **must** also be located in the -`lib/MetadataStore/` directory of your custom module. +`src/MetadataStore/` directory of your custom module. Bear in mind that **your class name must follow the PSR-0 autoloading standard**. This means it needs to be named in a particular way, with the use of namespaces being the preferred convention. For example, if your diff --git a/docs/simplesamlphp-modules.md b/docs/simplesamlphp-modules.md index c302b530d8df33fa81754a1b8e920e8efb61e9a0..7efe8697f42e763e92894e1d0c93049ef1e844d8 100644 --- a/docs/simplesamlphp-modules.md +++ b/docs/simplesamlphp-modules.md @@ -60,25 +60,25 @@ hooks file in this directory represents a single function. See the hook-section in the documentation for more information. -lib +src : This directory contains classes which belong to this module. All classes must be named in the following pattern: `\SimpleSAML\Module\<module name>\<class name>` When looking up the filename of - a class, SimpleSAMLphp will search for `<class name>` in the `lib` + a class, SimpleSAMLphp will search for `<class name>` in the `src` directory. Underscores in the class name will be translated into slashes. : Thus, if SimpleSAMLphp needs to load a class named `\SimpleSAML\Module\example\Auth\Source\Example`, it will load the file named - `modules/example/lib/Auth/Source/Example.php`. + `modules/example/src/Auth/Source/Example.php`. templates : These are module-specific templates. To use one of these - templates, specify `<module name>:<template file>.php` + templates, specify `<module name>:<template file>.twig` as the template file in the constructor of - `\SimpleSAML\XHTML\Template`. For example, `example:login-form.php` + `\SimpleSAML\XHTML\Template`. For example, `example:login-form.twig` is translated to the file - `modules/example/templates/default/login-form.php`. Note that + `modules/example/templates/default/login-form.twig`. Note that `default` in the previous example is defined by the `theme.use` configuration option. @@ -95,11 +95,11 @@ themes `<module name>:<theme name>`. : When using the theme `example:blue`, the template - `templates/default/login.php` will be overridden by - `modules/example/themes/blue/default/login.php`, while the template - `modules/core/templates/default/loginuserpass.php` will be + `templates/default/login.twig` will be overridden by + `modules/example/themes/blue/default/login.twig`, while the template + `modules/core/templates/default/loginuserpass.twig` will be overridden by - `modules/example/themes/blue/core/loginuserpass.php`. + `modules/example/themes/blue/core/loginuserpass.twig`. www : All files stored in this directory will be available by @@ -136,7 +136,7 @@ A typical configuration entry for an authentication source looks like this: 'example-static' => [ - /* This maps to modules/exampleauth/lib/Auth/Source/Static.php */ + /* This maps to modules/exampleauth/src/Auth/Source/Static.php */ 'exampleauth:StaticSource', /* The following is configuration which is passed on to