mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-07-09 12:30:15 +02:00
[ADD] Attempt to explain the sentinel user function
Let's see if the docs are generated properly with this
This commit is contained in:
parent
cbb5c80b94
commit
33ad1413d5
@ -7,5 +7,6 @@ Alliance Auth is providing its own CSS framework with a couple of CSS classes.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
framework/api
|
||||
framework/css
|
||||
```
|
||||
|
28
docs/development/custom/framework/api.md
Normal file
28
docs/development/custom/framework/api.md
Normal file
@ -0,0 +1,28 @@
|
||||
# Alliance Auth Helper-Functions API
|
||||
|
||||
## User API
|
||||
|
||||
### get_main_character_from_user
|
||||
|
||||
### get_main_character_name_from_user
|
||||
|
||||
### get_sentinel_user
|
||||
|
||||
This function is useful in models when using `User` model-objects as foreign keys.
|
||||
Django needs to know what should happen to those relations when the user is being
|
||||
deleted. To keep the data, you can have Django map this to the sentinel user.
|
||||
|
||||
Import:
|
||||
|
||||
```python
|
||||
from allianceauth.framework.api.user import get_sentinel_user
|
||||
```
|
||||
|
||||
And later in your model:
|
||||
|
||||
```python
|
||||
creator = models.ForeignKey(
|
||||
to=User,
|
||||
on_delete=models.SET(get_sentinel_user),
|
||||
)
|
||||
```
|
Loading…
x
Reference in New Issue
Block a user