Skip to content

Commit dd83594

Browse files
committed
Merge pull request #914 from pantheon-systems/update/documentation
Updated documentation and doc-making script
2 parents f871ca8 + 6629abd commit dd83594

File tree

11 files changed

+571
-21
lines changed

11 files changed

+571
-21
lines changed

docs/Helpers/AuthHelper.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Terminus\Helpers\AuthHelper
2+
3+
### __construct
4+
##### Description:
5+
Object constructor
6+
7+
##### Parameters:
8+
[array] $options Options and dependencies for this helper
9+
10+
##### Return:
11+
[AuthHelper]
12+
13+
---
14+
15+
### ensureLogin
16+
##### Description:
17+
Ensures the user is logged in or errs.
18+
19+
##### Return:
20+
[bool] Always true
21+
22+
##### Throws:
23+
TerminusException
24+
25+
---
26+
27+
### getMachineTokenCreationUrl
28+
##### Description:
29+
Generates the URL string for where to create a machine token
30+
31+
##### Return:
32+
[string]
33+
34+
---
35+
36+
### getOnlySavedToken
37+
##### Description:
38+
Gets the only saved token or returns false
39+
40+
##### Return:
41+
[bool|string]
42+
43+
---
44+
45+
### loggedIn
46+
##### Description:
47+
Checks to see if the current user is logged in
48+
49+
##### Return:
50+
[bool] True if the user is logged in
51+
52+
---
53+
54+
### logInViaMachineToken
55+
##### Description:
56+
Execute the login based on a machine token
57+
58+
##### Parameters:
59+
[string[]] $args Elements as follow:
60+
-string token Machine token to initiate login with
61+
-string email Email address to locate token with
62+
63+
##### Return:
64+
[bool] True if login succeeded
65+
66+
##### Throws:
67+
TerminusException
68+
69+
---
70+
71+
### logInViaUsernameAndPassword
72+
##### Description:
73+
Execute the login via email/password
74+
75+
##### Parameters:
76+
[string] $email Email address associated with a Pantheon account
77+
[string] $password Password for the account
78+
79+
##### Return:
80+
[bool] True if login succeeded
81+
82+
##### Throws:
83+
TerminusException
84+
85+
---
86+
87+
### tokenExistsForEmail
88+
##### Description:
89+
Checks to see whether the email has been set with a machine token
90+
91+
##### Parameters:
92+
[string] $email Email address to check for
93+
94+
##### Return:
95+
[bool]
96+
97+
---
98+

0 commit comments

Comments
 (0)