https://github.com/simplesamlphp/simplesamlphp-module-examplecomposer

An example SimpleSAMLphp module installable through Composer.
https://github.com/simplesamlphp/simplesamlphp-module-examplecomposer

Last synced: 9 months ago
JSON representation

An example SimpleSAMLphp module installable through Composer.

• Host: GitHub
• URL: https://github.com/simplesamlphp/simplesamlphp-module-examplecomposer
• Owner: simplesamlphp
• License: lgpl-2.1
• Created: 2014-02-24T12:30:59.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-03-25T21:00:32.000Z (almost 2 years ago)
• Last Synced: 2024-04-25T15:21:12.005Z (almost 2 years ago)
• Language: PHP
• Size: 61.5 KB
• Stars: 0
• Watchers: 9
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SimpleSAMLphp Composer module example

![Build Status](https://github.com/simplesamlphp/simplesamlphp-module-examplecomposer/actions/workflows/php.yml/badge.svg)

[![Coverage Status](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-examplecomposer/branch/master/graph/badge.svg)](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-examplecomposer)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/simplesamlphp/simplesamlphp-module-examplecomposer/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/simplesamlphp/simplesamlphp-module-examplecomposer/?branch=master)

[![Type Coverage](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-examplecomposer/coverage.svg)](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-examplecomposer)

[![Psalm Level](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-examplecomposer/level.svg)](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-examplecomposer)

## Install

This package is an example of a SimpleSAMLphp module installable through

[Composer](https://getcomposer.org/). Installation can be as easy as executing:

```bash

vendor/bin/composer require simplesamlphp/simplesamlphp-module-examplecomposer

```

## Configuration

Next thing you need to do is to enable the module:

in `config.php`, search for the `module.enable` key and set `examplecomposer` to true:

```php

'module.enable' => [ 'examplecomposer' => true, … ],

```

You can access the hello-world script at: `/simplesaml/module.php/examplecomposer/helloworld`

See the [SimpleSAMLphp Composer module installer](https://github.com/simplesamlphp/composer-module-installer)

documentation for more information about creating modules installable through Composer.

## Relevant files

This module consists of the following files:

- `composer.json`: The composer configuration file for this module.

- `README.md`: This document describing the module.

- `src/Controller/ExampleController.php`: Controller outputting `Hello World!` when executed.