c4cf0b9bb7
Checking if a user was enrolled in a program type was using the `name` field which is subject to be translated. This change allows for us to check by the type's slug which will be constant. This also includes the addition of api.py files for the course_modes, catalog, and programs apps.
31 lines
1.4 KiB
Python
31 lines
1.4 KiB
Python
"""
|
|
Python APIs exposed by the Programs app to other in-process apps.
|
|
"""
|
|
|
|
from .utils import is_user_enrolled_in_program_type as _is_user_enrolled_in_program_type
|
|
|
|
|
|
def is_user_enrolled_in_program_type(user, program_type_slug, paid_modes=False, enrollments=None, entitlements=None):
|
|
"""
|
|
This method will look at the learners Enrollments and Entitlements to determine
|
|
if a learner is enrolled in a Program of the given type.
|
|
|
|
NOTE: This method relies on the Program Cache right now. The goal is to move away from this
|
|
in the future.
|
|
|
|
Arguments:
|
|
user (User): The user we are looking for.
|
|
program_type_slug (str): The slug of the Program type we are looking for.
|
|
paid_modes (bool): Request if the user is enrolled in a Program in a paid mode, False by default.
|
|
enrollments (List[Dict]): Takes a serialized list of CourseEnrollments linked to the user
|
|
entitlements (List[CourseEntitlement]): Take a list of CourseEntitlement objects linked to the user
|
|
|
|
NOTE: Both enrollments and entitlements will be collected if they are not passed in. They are available
|
|
as parameters in case they were already collected, to save duplicate queries in high traffic areas.
|
|
|
|
Returns:
|
|
bool: True is the user is enrolled in programs of the requested type
|
|
"""
|
|
|
|
return _is_user_enrolled_in_program_type(user, program_type_slug, paid_modes, enrollments, entitlements)
|