Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-12-18 06:45:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

[ADD] Evecharacter API functions

Browse Source
This commit is contained in:
Peter Pfeufer
2024-01-24 20:32:04 +01:00
parent d5fda05dc9
commit 13a8b7678f
3 changed files with 104 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/development/custom/aa-framework.md
View File

@@ -1,7 +1,12 @@
# AA Framework
To establish a unified style language throughout Alliance Auth and Community Apps,
Alliance Auth is providing its own CSS framework with a couple of CSS classes.
This section contains information about the Alliance Auth framework and how to use it.
The Alliance Auth framework is a collection of reusable Python code as well as CSS classes
that are used throughout Alliance Auth. It is designed to be used by developers of community apps
to make their lives easier.
The Alliance Auth framework is split into several submodules, each of which is documented in its own section.
:::{toctree}
:maxdepth: 1

41
docs/development/custom/framework/api.md
View File

@@ -1,5 +1,44 @@
# Alliance Auth Helper-Functions API
The following helper-functions are available in the `allianceauth.framework.api` module.
They are intended to be used in Alliance Auth itself as well as in the community apps.
These functions are intended to make the life of our community apps developer a little
easier, so they don't have to reinvent the wheel all the time.
## Evecharacter API
### get_main_character_from_evecharacter
This is to get the main character object (`EveCharacter`) of an `EveCharacter` object.
Given we have an `EveCharacter` object called `my_evecharacter` and we want to get the main character:
```python
# Alliance Auth
from allianceauth.framework.api.evecharacter import get_main_character_from_evecharacter
main_character = get_main_character_from_evecharacter(character=my_evecharacter)
```
Now, `main_character` is an `EveCharacter` object, or `None` if the `EveCharacter` has no main character.
### get_user_from_evecharacter
This is to get the user object (`User`) of an `EveCharacter` object.
Given we have an `EveCharacter` object called `my_evecharacter` and we want to get the user:
```python
# Alliance Auth
from allianceauth.framework.api.evecharacter import get_user_from_evecharacter
user = get_user_from_evecharacter(character=my_evecharacter)
```
Now, `user` is a `User` object, or the sentinel username (see [get_sentinel_user](#get-sentinel-user))
if the `EveCharacter` has no user.
## User API
### get_main_character_from_user
@@ -20,7 +59,7 @@ character or the user is `None`.
### get_main_character_name_from_user
This is to get the name of the main character of a user.
This is to get the name of the main character from a user.
Given we have a `User` object called `my_user` and we want to get the main character name: