Laravel 5.7 - SessionGuard (Auth)
SessionGuard

SessionGuard
वर्ग सत्रगार्ड लागू SupportsBasicAuth StatefulGuard , SupportsBasicAuth ( स्रोत देखें )
लक्षण
GuardHelpers | ये तरीके आमतौर पर सभी गार्डों में समान होते हैं। |
Macroable |
गुण
संरक्षित Authenticatable | उपयोगकर्ता $ | वर्तमान में प्रमाणित उपयोगकर्ता। | GuardHelpers |
संरक्षित UserProvider | $ प्रदाता | उपयोगकर्ता प्रदाता कार्यान्वयन। | GuardHelpers |
स्थिर संरक्षित सरणी | $ मैक्रो | पंजीकृत स्ट्रिंग मैक्रो। | Macroable |
संरक्षित स्ट्रिंग | $ नाम | गार्ड का नाम। आमतौर पर "सत्र"। | |
संरक्षित Authenticatable | $ lastAttempted | जिस उपयोगकर्ता को हमने अंतिम बार पुनर्प्राप्त करने का प्रयास किया था। | |
संरक्षित बूल | $ viaRemember | इंगित करता है कि उपयोगकर्ता को एक रिकॉलर कुकी के माध्यम से प्रमाणित किया गया था। | |
संरक्षित Session | $ सत्र | गार्ड द्वारा उपयोग किया जाने वाला सत्र। | |
संरक्षित QueueingFactory | $ कुकी | प्रबुद्ध कुकी निर्माता सेवा। | |
संरक्षित अनुरोध | $ अनुरोध | अनुरोध उदाहरण। | |
संरक्षित Dispatcher | $ घटनाओं | घटना प्रेषण उदाहरण। | |
संरक्षित बूल | $ loggedOut | यदि लॉगआउट विधि को कॉल किया गया है तो इंगित करता है। | |
संरक्षित बूल | $ recallAttempted | यदि टोकन उपयोगकर्ता पुनर्प्राप्ति का प्रयास किया गया है, तो यह इंगित करता है। |
तरीके
Authenticatable |
authenticate
()
निर्धारित करें कि क्या वर्तमान उपयोगकर्ता प्रमाणित है। यदि नहीं, तो एक अपवाद फेंकें। |
GuardHelpers |
bool |
hasUser
()
निर्धारित करें कि क्या गार्ड में उपयोगकर्ता का उदाहरण है। |
GuardHelpers |
bool |
check
()
निर्धारित करें कि क्या वर्तमान उपयोगकर्ता प्रमाणित है। |
GuardHelpers |
bool |
guest
()
निर्धारित करें कि क्या वर्तमान उपयोगकर्ता एक अतिथि है। |
GuardHelpers |
पूर्णांक | अशक्त |
id
()
वर्तमान में प्रमाणित उपयोगकर्ता के लिए आईडी प्राप्त करें। |
|
शून्य |
setUser
(
Authenticatable
$ उपयोगकर्ता)
वर्तमान उपयोगकर्ता सेट करें। |
|
UserProvider |
getProvider
()
गार्ड द्वारा उपयोग किया गया उपयोगकर्ता प्रदाता प्राप्त करें। |
GuardHelpers |
शून्य |
setProvider
(
UserProvider
$ प्रदाता)
गार्ड द्वारा उपयोग किया गया उपयोगकर्ता प्रदाता सेट करें। |
GuardHelpers |
स्थिर शून्य |
macro
(स्ट्रिंग $ नाम, वस्तु | कॉल करने योग्य $ मैक्रो)
एक कस्टम मैक्रो पंजीकृत करें। |
Macroable |
स्थिर शून्य |
mixin
(ऑब्जेक्ट $ मिक्सिन)
कक्षा में दूसरी वस्तु मिलाएं। |
Macroable |
स्थिर मल |
hasMacro
(स्ट्रिंग $ नाम)
जाँच करता है कि मैक्रो पंजीकृत है या नहीं। |
Macroable |
स्थिर मिश्रित |
__callStatic
(स्ट्रिंग $ विधि, सरणी $ पैरामीटर)
गतिशील रूप से कक्षा को कॉल संभालते हैं। |
Macroable |
मिश्रित |
__call
(स्ट्रिंग $ पद्धति, सरणी $ पैरामीटर)
गतिशील रूप से कक्षा को कॉल संभालते हैं। |
Macroable |
शून्य |
__construct
(स्ट्रिंग $ नाम,
UserProvider
$ प्रदाता,
Session
$ सत्र, अनुरोध $ अनुरोध = अशक्त)
एक नया प्रमाणीकरण गार्ड बनाएँ। |
|
Authenticatable | अशक्त | |
user
()
वर्तमान में प्रमाणित उपयोगकर्ता प्राप्त करें। |
|
मिश्रित |
userFromRecaller
(
Recaller
$ रिकॉलर)
एक उपयोगकर्ता को रिपॉजिटरी से उसके "मुझे याद रखें" कुकी टोकन खींचो। |
|
Recaller | अशक्त | |
recaller
()
अनुरोध के लिए डिक्रिप्टेड रिकॉलर कुकी प्राप्त करें। |
|
bool |
once
(सरणी $ क्रेडेंशियल्स = [])
किसी उपयोगकर्ता को सत्र या कुकीज़ के बिना आवेदन में लॉग इन करें। |
|
bool |
onceUsingId
(मिश्रित $ आईडी)
दिए गए उपयोगकर्ता आईडी को सत्र या कुकीज़ के बिना आवेदन में लॉग इन करें। |
|
bool |
validate
(सरणी $ क्रेडेंशियल्स = [])
उपयोगकर्ता की साख को मान्य करें। |
|
प्रतिक्रिया | अशक्त |
basic
(स्ट्रिंग $ फ़ील्ड = 'ईमेल', सरणी $ अतिरिक्त शर्तें = [])
HTTP बेसिक प्रामाणिक का उपयोग करके प्रमाणित करने का प्रयास करें। |
|
प्रतिक्रिया | अशक्त |
onceBasic
(स्ट्रिंग $ फ़ील्ड = 'ईमेल', सरणी $ अतिरिक्त शर्तें = [])
एक स्टेटलेस HTTP बेसिक लॉगिन प्रयास करें। |
|
bool |
attemptBasic
(अनुरोध $ अनुरोध, स्ट्रिंग $ फ़ील्ड, सरणी $ extraConditions = [])
मूल प्रमाणीकरण का उपयोग करके प्रमाणित करने का प्रयास। |
|
सरणी |
basicCredentials
(अनुरोध $ अनुरोध, स्ट्रिंग $ क्षेत्र)
HTTP मूल अनुरोध के लिए क्रेडेंशियल सरणी प्राप्त करें। |
|
शून्य |
failedBasicResponse
मूल प्रमाणीकरण के लिए प्रतिक्रिया प्राप्त करें। |
|
bool |
attempt
(सरणी $ क्रेडेंशियल्स = [], बूल $ याद = गलत)
दिए गए क्रेडेंशियल्स का उपयोग करके उपयोगकर्ता को प्रमाणित करने का प्रयास करें। |
|
bool |
hasValidCredentials
(मिश्रित $ उपयोगकर्ता, सरणी $ क्रेडेंशियल्स)
निर्धारित करें कि उपयोगकर्ता क्रेडेंशियल्स से मेल खाता है या नहीं। |
|
Authenticatable |
loginUsingId
(मिश्रित $ id, बूल $ याद = गलत)
दिए गए यूजर आईडी को आवेदन में लॉग इन करें। |
|
शून्य |
login
(
Authenticatable
$ उपयोगकर्ता, बूल $ याद = गलत)
किसी उपयोगकर्ता को एप्लिकेशन में लॉग इन करें। |
|
शून्य |
updateSession
(स्ट्रिंग $ आईडी)
दिए गए आईडी के साथ सत्र को अपडेट करें। |
|
शून्य |
ensureRememberTokenIsSet
(
Authenticatable
$ उपयोगकर्ता)
यदि कोई पहले से मौजूद नहीं है, तो उपयोगकर्ता के लिए एक नया "मुझे याद रखें" टोकन बनाएं। |
|
शून्य |
queueRecallerCookie
(
Authenticatable
$ उपयोगकर्ता)
कुकी जार में रिकॉलर कुकी को कतार में रखें। |
|
कुकी |
createRecaller
(स्ट्रिंग $ मूल्य)
किसी दिए गए ID के लिए "मुझे याद रखें" कुकी बनाएँ। |
|
शून्य |
logout
()
उपयोगकर्ता को एप्लिकेशन से लॉग आउट करें। |
|
शून्य |
clearUserDataFromStorage
()
सत्र और कुकीज़ से उपयोगकर्ता डेटा निकालें। |
|
शून्य |
cycleRememberToken
(
Authenticatable
$ उपयोगकर्ता)
उपयोगकर्ता के लिए "मुझे याद रखें" टोकन को ताज़ा करें। |
|
bool | अशक्त |
logoutOtherDevices
(स्ट्रिंग $ पासवर्ड, स्ट्रिंग $ विशेषता = 'पासवर्ड')
वर्तमान उपयोगकर्ता के लिए अन्य सत्र अमान्य करें। |
|
शून्य |
attempting
(मिश्रित $ कॉलबैक)
प्रमाणीकरण प्रयास ईवेंट श्रोता पंजीकृत करें। |
|
शून्य |
fireAttemptEvent
(सरणी $ क्रेडेंशियल्स, बूल $ याद = गलत)
तर्कों के साथ प्रयास घटना को आग लगाओ। |
|
शून्य |
fireLoginEvent
(
Authenticatable
$ उपयोगकर्ता, बूल $ याद = गलत)
यदि डिस्पैचर सेट है, तो लॉगिन ईवेंट को फायर करें। |
|
शून्य |
fireAuthenticatedEvent
(
Authenticatable
$ उपयोगकर्ता)
यदि डिस्पैचर सेट है, तो प्रमाणित घटना को आग दें। |
|
शून्य |
fireFailedEvent
(
Authenticatable
। शून्य $ उपयोगकर्ता, सरणी $ क्रेडेंशियल्स)
दिए गए तर्कों के साथ असफल प्रमाणीकरण प्रयास घटना को फायर करें। |
|
Authenticatable |
getLastAttempted
()
अंतिम उपयोगकर्ता प्राप्त करें जिसे हमने प्रमाणित करने का प्रयास किया है। |
|
तार |
getName
()
विशिष्ट सत्र मान के लिए एक विशिष्ट पहचानकर्ता प्राप्त करें। |
|
तार |
getRecallerName
()
कुकी के नाम को "रिकॉलर" स्टोर करने के लिए उपयोग करें। |
|
bool |
viaRemember
()
निर्धारित करें कि क्या उपयोगकर्ता "मुझे याद रखें" कुकी के माध्यम से प्रमाणित हुआ था। |
|
QueueingFactory |
getCookieJar
()
गार्ड द्वारा उपयोग किया गया कुकी निर्माता उदाहरण प्राप्त करें। |
|
शून्य |
setCookieJar
(
QueueingFactory
$ कुकी)
गार्ड द्वारा उपयोग किए जाने वाले कुकी निर्माता का उदाहरण सेट करें। |
|
Dispatcher |
getDispatcher
()
घटना प्रेषण उदाहरण प्राप्त करें। |
|
शून्य |
setDispatcher
(
Dispatcher
$ ईवेंट)
घटना प्रेषण उदाहरण सेट करें। |
|
Session |
getSession
()
गार्ड द्वारा उपयोग किया जाने वाला सत्र स्टोर प्राप्त करें। |
|
Authenticatable | अशक्त | |
getUser
()
वर्तमान में कैश की गई उपयोगकर्ता को लौटाएं। |
|
निवेदन |
getRequest
()
वर्तमान अनुरोध उदाहरण प्राप्त करें। |
|
इस $ |
setRequest
(अनुरोध $ अनुरोध)
वर्तमान अनुरोध उदाहरण सेट करें। |
विवरण
Authenticatable प्रमाणिक ()
निर्धारित करें कि क्या वर्तमान उपयोगकर्ता प्रमाणित है। यदि नहीं, तो एक अपवाद फेंकें।
बूल हैसर ()
निर्धारित करें कि क्या गार्ड में उपयोगकर्ता का उदाहरण है।
बूल चेक ()
निर्धारित करें कि क्या वर्तमान उपयोगकर्ता प्रमाणित है।
बूल गेस्ट ()
निर्धारित करें कि क्या वर्तमान उपयोगकर्ता एक अतिथि है।
int | null id ()
वर्तमान में प्रमाणित उपयोगकर्ता के लिए आईडी प्राप्त करें।
शून्य सेटउज़र ( Authenticatable $ उपयोगकर्ता)
वर्तमान उपयोगकर्ता सेट करें।
UserProvider getProvider ()
गार्ड द्वारा उपयोग किया गया उपयोगकर्ता प्रदाता प्राप्त करें।
शून्य सेटप्रॉइडर ( UserProvider $ प्रदाता)
गार्ड द्वारा उपयोग किया गया उपयोगकर्ता प्रदाता सेट करें।
स्थिर शून्य मैक्रो (स्ट्रिंग $ नाम, ऑब्जेक्ट | कॉल करने योग्य $ मैक्रो)
एक कस्टम मैक्रो पंजीकृत करें।
स्थिर शून्य मिक्सिन (ऑब्जेक्ट $ मिक्सिन)
कक्षा में दूसरी वस्तु मिलाएं।
स्थिर बूल हैमैक्रो (स्ट्रिंग $ नाम)
जाँच करता है कि मैक्रो पंजीकृत है या नहीं।
स्थिर मिश्रित __callStatic (स्ट्रिंग $ विधि, सरणी $ पैरामीटर)
गतिशील रूप से कक्षा को कॉल संभालते हैं।
मिश्रित __call (स्ट्रिंग $ विधि, सरणी $ पैरामीटर)
गतिशील रूप से कक्षा को कॉल संभालते हैं।
शून्य __construct (स्ट्रिंग $ नाम, UserProvider $ प्रदाता, Session $ सत्र, अनुरोध $ अनुरोध = अशक्त)
एक नया प्रमाणीकरण गार्ड बनाएँ।
Authenticatable उपयोगकर्ता | अशक्त उपयोगकर्ता ()
वर्तमान में प्रमाणित उपयोगकर्ता प्राप्त करें।
संरक्षित मिश्रित उपयोगकर्ताFromRecaller ( Recaller $ रिकॉलर)
एक उपयोगकर्ता को रिपॉजिटरी से उसके "मुझे याद रखें" कुकी टोकन खींचो।
संरक्षित Recaller | नल रिकॉलर ()
अनुरोध के लिए डिक्रिप्टेड रिकॉलर कुकी प्राप्त करें।
बूल एक बार (सरणी $ क्रेडेंशियल्स = [])
किसी उपयोगकर्ता को सत्र या कुकीज़ के बिना आवेदन में लॉग इन करें।
बूल oneUsingId (मिश्रित $ आईडी)
दिए गए उपयोगकर्ता आईडी को सत्र या कुकीज़ के बिना आवेदन में लॉग इन करें।
बूल वैलिडेट (सरणी $ क्रेडेंशियल्स = [])
उपयोगकर्ता की साख को मान्य करें।
प्रतिक्रिया | अशक्त मूल (स्ट्रिंग $ फ़ील्ड = 'ईमेल', सरणी $ अतिरिक्त शर्तें = []]
HTTP बेसिक प्रामाणिक का उपयोग करके प्रमाणित करने का प्रयास करें।
प्रतिक्रिया | एक बार अशक्त (स्ट्रिंग $ फ़ील्ड = 'ईमेल', सरणी $ अतिरिक्त शर्तें = [])
एक स्टेटलेस HTTP बेसिक लॉगिन प्रयास करें।
संरक्षित बूल प्रयासबिकसिक (अनुरोध $ अनुरोध, स्ट्रिंग $ फ़ील्ड, सरणी $ अतिरिक्त शर्तें = [])
मूल प्रमाणीकरण का उपयोग करके प्रमाणित करने का प्रयास।
संरक्षित सरणी बुनियादी सुविधाएँ (अनुरोध $ अनुरोध, स्ट्रिंग $ क्षेत्र)
HTTP मूल अनुरोध के लिए क्रेडेंशियल सरणी प्राप्त करें।
संरक्षित शून्य विफल
मूल प्रमाणीकरण के लिए प्रतिक्रिया प्राप्त करें।
बूल प्रयास (सरणी $ क्रेडेंशियल्स = [], बूल $ याद = गलत)
दिए गए क्रेडेंशियल्स का उपयोग करके उपयोगकर्ता को प्रमाणित करने का प्रयास करें।
संरक्षित बूल के पासविशिष्ट अंश हैं (मिश्रित $ उपयोगकर्ता, सरणी $ क्रेडेंशियल्स)
निर्धारित करें कि उपयोगकर्ता क्रेडेंशियल्स से मेल खाता है या नहीं।
ऑथेंटिकटेबुल लॉगिन लॉगिन (मिश्रित $ आईडी, बूल $ याद = गलत)
दिए गए यूजर आईडी को आवेदन में लॉग इन करें।
शून्य लॉगिन ( Authenticatable $ उपयोगकर्ता, बूल $ याद = गलत)
किसी उपयोगकर्ता को एप्लिकेशन में लॉग इन करें।
संरक्षित शून्य अद्यतन (स्ट्रिंग $ आईडी)
दिए गए आईडी के साथ सत्र को अपडेट करें।
संरक्षित शून्य सुनिश्चित करें। RememberTokenIsSet ( Authenticatable $ उपयोगकर्ता)
यदि कोई पहले से मौजूद नहीं है, तो उपयोगकर्ता के लिए एक नया "मुझे याद रखें" टोकन बनाएं।
संरक्षित शून्य कताररैलर कूकी ( Authenticatable $ उपयोगकर्ता)
कुकी जार में रिकॉलर कुकी को कतार में रखें।
संरक्षित कुकी createRecaller (स्ट्रिंग $ मूल्य)
किसी दिए गए ID के लिए "मुझे याद रखें" कुकी बनाएँ।
शून्य लॉगआउट ()
उपयोगकर्ता को एप्लिकेशन से लॉग आउट करें।
संरक्षित शून्य क्लियरयूजरडैटाफ्रॉमस्टोरेज ()
सत्र और कुकीज़ से उपयोगकर्ता डेटा निकालें।
रक्षित शून्य चक्र। रिमेम्बरटोकन ( Authenticatable $ उपयोगकर्ता)
उपयोगकर्ता के लिए "मुझे याद रखें" टोकन को ताज़ा करें।
बूल | शून्य लॉगआउटऑथरडिव्स (स्ट्रिंग $ पासवर्ड, स्ट्रिंग $ विशेषता = 'पासवर्ड')
वर्तमान उपयोगकर्ता के लिए अन्य सत्र अमान्य करें।
एप्लिकेशन को AuthenticateSession मिडिलवेयर का उपयोग करना चाहिए।
शून्य प्रयास (मिश्रित $ कॉलबैक)
प्रमाणीकरण प्रयास ईवेंट श्रोता पंजीकृत करें।
संरक्षित शून्य फ़ायरअटेम्प्टवेंट (सरणी $ क्रेडेंशियल्स, बूल $ याद = गलत)
तर्कों के साथ प्रयास घटना को आग लगाओ।
संरक्षित शून्य फ़ायरलॉगइनवेंट ( Authenticatable $ उपयोगकर्ता, बूल $ याद = गलत)
यदि डिस्पैचर सेट है, तो लॉगिन ईवेंट को फायर करें।
संरक्षित शून्य फ़ायरअथेंटेडइवेंट ( Authenticatable $ उपयोगकर्ता)
यदि डिस्पैचर सेट है, तो प्रमाणित घटना को आग दें।
संरक्षित शून्य फ़ायरफ़ेल्डवेंट ( Authenticatable । शून्य $ उपयोगकर्ता, सरणी $ क्रेडेंशियल्स)
दिए गए तर्कों के साथ असफल प्रमाणीकरण प्रयास घटना को फायर करें।
Authenticatable getLastAttempted ()
अंतिम उपयोगकर्ता प्राप्त करें जिसे हमने प्रमाणित करने का प्रयास किया है।
स्ट्रिंग गेटनेम ()
विशिष्ट सत्र मान के लिए एक विशिष्ट पहचानकर्ता प्राप्त करें।
स्ट्रिंग getRecallerName ()
कुकी के नाम को "रिकॉलर" स्टोर करने के लिए उपयोग करें।
बूल थ्रू रेंम्बर ()
निर्धारित करें कि क्या उपयोगकर्ता "मुझे याद रखें" कुकी के माध्यम से प्रमाणित हुआ था।
QueueingFactory getCookieJar ()
गार्ड द्वारा उपयोग किया गया कुकी निर्माता उदाहरण प्राप्त करें।
शून्य सेटकेजी जार ( QueueingFactory $ कूकी)
गार्ड द्वारा उपयोग किए जाने वाले कुकी निर्माता का उदाहरण सेट करें।
Dispatcher getDispatcher ()
घटना प्रेषण उदाहरण प्राप्त करें।
शून्य सेटडिस्पैचर ( Dispatcher $ ईवेंट)
घटना प्रेषण उदाहरण सेट करें।
Session गेटसेशन ()
गार्ड द्वारा उपयोग किया जाने वाला सत्र स्टोर प्राप्त करें।
Authenticatable । अशक्त getUser ()
वर्तमान में कैश की गई उपयोगकर्ता को लौटाएं।
अनुरोध प्राप्त करें ()
वर्तमान अनुरोध उदाहरण प्राप्त करें।
$ यह सेटप्रिन्येस्ट (अनुरोध $ अनुरोध)
वर्तमान अनुरोध उदाहरण सेट करें।