Skip to content

Phase

hypha.apply.funds.workflows.models.phase

Phase 

Phase(name, display, stage, permissions, step, public=None, future=None, transitions=None)

Phase Names: display_name = phase name displayed to staff members in the system public_name = phase name displayed to applicants in the system future_name = phase_name displayed to applicants if they haven't passed this stage

Source code in hypha/apply/funds/workflows/models/phase.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def __init__(
    self,
    name,
    display,
    stage,
    permissions,
    step,
    public=None,
    future=None,
    transitions=None,
):
    if transitions is None:
        transitions = {}
    self.name = name
    self.display_name = display
    self.display_slug = slugify(display)
    if public and future:
        raise ValueError("Cant provide both a future and a public name")

    self.public_name = public or self.display_name
    self.future_name_staff = future or self.display_name
    self.bg_color = PHASE_BG_COLORS.get(self.display_name, "bg-gray-200")
    self.future_name_public = future or self.public_name
    self.stage = stage
    self.permissions = Permissions(permissions)
    self.step = step

    # For building transition methods on the parent
    self.transitions = {}

    default_permissions = {
        UserPermissions.STAFF,
        UserPermissions.LEAD,
        UserPermissions.ADMIN,
    }

    for transition_target, action in transitions.items():
        transition = {}
        try:
            transition["display"] = action.get("display")
        except AttributeError:
            transition["display"] = action
            transition["permissions"] = default_permissions
        else:
            transition["method"] = action.get("method")
            conditions = action.get("conditions", "")
            transition["conditions"] = conditions.split(",") if conditions else []
            transition["permissions"] = action.get(
                "permissions", default_permissions
            )
            if "custom" in action:
                transition["custom"] = action["custom"]

        self.transitions[transition_target] = transition

name instance-attribute 

name = name

display_name instance-attribute 

display_name = display

display_slug instance-attribute 

display_slug = slugify(display)

public_name instance-attribute 

public_name = public or display_name

future_name_staff instance-attribute 

future_name_staff = future or display_name

bg_color instance-attribute 

bg_color = get(display_name, 'bg-gray-200')

future_name_public instance-attribute 

future_name_public = future or public_name

stage instance-attribute 

stage = stage

permissions instance-attribute 

permissions = Permissions(permissions)

step instance-attribute 

step = step

transitions instance-attribute 

transitions = {}