Skip to content

Commit f1b09d3

Browse files
committed
Formatting changes
1 parent 9b123e8 commit f1b09d3

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ CREATE TABLE `AttributeFromSQL` (
3737
Usage
3838
-----
3939

40-
This module provides the sqlattribs:AttributeFromSQL auth proc filter, which can be used as follows:
40+
This module provides the _sqlattribs:AttributeFromSQL_ auth proc filter,
41+
which can be used as follows:
4142

4243
```php
4344
50 => array(
@@ -56,23 +57,23 @@ This module provides the sqlattribs:AttributeFromSQL auth proc filter, which can
5657

5758
Where the parameters are as follows:
5859

59-
* `class` - the name of the class, must be `sqlattribs:AttributeFromSQL`
60+
* `class` - the name of the class, must be _sqlattribs:AttributeFromSQL_
6061

61-
* `attribute` - the attribute to use as the uid/key for database searches, defaults to `eduPersonPrincipalName` if not specified.
62+
* `attribute` - the attribute to use as the uid/key for database searches, defaults to _eduPersonPrincipalName_ if not specified.
6263

6364
* `limit` - an optional array specifying the attribute names we can add. If not specified, all attributes that are found in the database are added. Defaults to allowing all attributes.
6465

6566
* `replace` - behaviour when an existing attribute of the same name is encountered. If `false` (the default) then new values are pushed into an array, creating a multi-valued attribute. If `true`, then existing attributes of the same name are replaced (deleted).
6667

6768
* `database` - an array containing information about the data store, with the following parameters:
6869

69-
* `dsn` - the data source name, defaults to `mysql:host=localhost;dbname=simplesamlphp`
70+
* `dsn` - the data source name, defaults to _mysql:host=localhost;dbname=simplesamlphp_
7071

7172
* `username` - the username to connect to the database, defaults to none (blank username)
7273

7374
* `password` - the password to connect to the database, defaults to none (blank password)
7475

75-
* `table` - the name of the table/view to search for attributes, defaults to `AttributeFromSQL`
76+
* `table` - the name of the table/view to search for attributes, defaults to _AttributeFromSQL_
7677

7778
Adding attributes
7879
-----------------
@@ -87,13 +88,13 @@ INSERT INTO AttributeFromSQL (uid, sp, attribute, value) VALUES ('user@example.o
8788
INSERT INTO AttributeFromSQL (uid, attribute, value) VALUES ('user@example.org', 'mail', 'user@example.org');
8889
```
8990

90-
The optional `sp` field (defaults to '%' with the above SQL CREATE) is used
91+
The optional _sp_ field (defaults to '%' with the above SQL CREATE) is used
9192
to limit which SP sees a particular attribute. The special value `%`
9293
is used to indicate all SPs. If you wish to indicate more than one SP but
9394
not all, insert multiple lines.
9495

9596
Where multiple attributes of the same name occur, these become a single
96-
multi-valued attribute. Thus assuming the user `user@example.org`
97+
multi-valued attribute. Thus assuming the user _user@example.org_
9798
started with attributes of:
9899

99100
```php
@@ -122,4 +123,5 @@ $attributes = array(
122123
),
123124
```
124125

125-
Note that because the the `limit` parameter, the mail attribute was not added. And because `replace` was false, eduPersonAffiliation was merged. It is assumed that this SP has an Entity Id of `https://sp.example.org/shibboleth-sp` - other SPs would not see the SP-specific eduPersonEntitlement attribute.
126+
Note that because the the `limit` parameter, the mail attribute was not added. And because `replace` was false, _eduPersonAffiliation_ was merged. It is assumed that this SP has an Entity Id of `https://sp.example.org/shibboleth-sp` - other SPs would not see the SP-specific _eduPersonEntitlement_ attribute.
127+

0 commit comments

Comments
 (0)