Skip to content

Commit a59bf51

Browse files
committed
Fix inconsistency in the documentation.
The guidelines on how to write your own module talk about the process() method receiving a “$request” or a “$state” parameter, instead of being consistent and sticking to just one of the names. Use “$request”.
1 parent 70bdb78 commit a59bf51

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/simplesamlphp-authproc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Requirements for authentication processing filters:
166166

167167
- Must be derived from the `SimpleSAML_Auth_ProcessingFilter`-class.
168168
- If a constructor is implemented, it must first call the parent constructor, passing along all parameters, before accessing any of the parameters. In general, only the $config parameter should be accessed.
169-
- The `process(&$state)`-function must be implemented. If this function completes, it is assumed that processing is completed, and that the $request array has been updated.
169+
- The `process(&$request)`-function must be implemented. If this function completes, it is assumed that processing is completed, and that the $request array has been updated.
170170
- If the `process`-function does not return, it must at a later time call `SimpleSAML_Auth_ProcessingChain::resumeProcessing` with the new request state. The request state must be an update of the array passed to the `process`-function.
171171
- No pages may be shown to the user from the `process`-function. Instead, the request state should be saved, and the user should be redirected to a new page. This must be done to prevent unpredictable events if the user for example reloads the page.
172172
- No state information should be stored in the filter object. It must instead be stored in the request state array. Any changes to variables in the filter object may be lost.

0 commit comments

Comments
 (0)