Laravel 5.6 - SessionGuard (Auth)

SessionGuard




laravel

कक्षा सत्रगार्ड लागू SupportsBasicAuth StatefulGuard , SupportsBasicAuth BasicAuth ( स्रोत देखें )

लक्षण

GuardHelpers ये विधियां आम तौर पर सभी गार्डों में समान होती हैं।
Macroable

गुण

संरक्षित Authenticatable उपयोगकर्ता $ वर्तमान में प्रमाणीकृत उपयोगकर्ता। GuardHelpers
संरक्षित UserProvider $ प्रदाता उपयोगकर्ता प्रदाता कार्यान्वयन। GuardHelpers
स्थिर संरक्षित सरणी $ मैक्रो पंजीकृत स्ट्रिंग मैक्रोज़। Macroable
संरक्षित स्ट्रिंग $ नाम गार्ड का नाम आम तौर पर "सत्र"।
संरक्षित Authenticatable $ lastAttempted जिस उपयोगकर्ता को हमने पिछली बार पुनर्प्राप्त करने का प्रयास किया था।
संरक्षित बूल $ viaRemember इंगित करता है कि उपयोगकर्ता को रिमूटर कुकी के माध्यम से प्रमाणित किया गया था या नहीं।
संरक्षित Session $ सत्र गार्ड द्वारा इस्तेमाल सत्र।
$ कुकी रोशनी कुकी निर्माता सेवा।
संरक्षित अनुरोध $ अनुरोध अनुरोध उदाहरण
संरक्षित Dispatcher $ घटनाओं घटना प्रेषक उदाहरण।
संरक्षित बूल $ loggedOut इंगित करता है कि लॉगआउट विधि कहलाती है या नहीं।
संरक्षित बूल $ recallAttempted इंगित करता है कि टोकन उपयोगकर्ता पुनर्प्राप्ति का प्रयास किया गया है या नहीं।

तरीके

Authenticatable authenticate ()

निर्धारित करें कि वर्तमान उपयोगकर्ता प्रमाणीकृत है या नहीं।

GuardHelpers
bool check ()

निर्धारित करें कि वर्तमान उपयोगकर्ता प्रमाणीकृत है या नहीं।

GuardHelpers
bool guest ()

निर्धारित करें कि वर्तमान उपयोगकर्ता अतिथि है या नहीं।

GuardHelpers
पूर्णांक | अशक्त id ()

वर्तमान में प्रमाणीकृत उपयोगकर्ता के लिए आईडी प्राप्त करें।

शून्य setUser ( Authenticatable उपयोगकर्ता उपयोगकर्ता)

वर्तमान उपयोगकर्ता सेट करें।

UserProvider getProvider ()

गार्ड द्वारा उपयोग किए जाने वाले उपयोगकर्ता प्रदाता को प्राप्त करें।

GuardHelpers
शून्य setProvider ( UserProvider $ प्रदाता)

गार्ड द्वारा उपयोग किए जाने वाले उपयोगकर्ता प्रदाता को सेट करें।

GuardHelpers
स्थैतिक शून्य macro (स्ट्रिंग $ नाम, ऑब्जेक्ट | कॉल करने योग्य $ मैक्रो)

एक कस्टम मैक्रो पंजीकृत करें।

Macroable
स्थैतिक शून्य mixin (ऑब्जेक्ट $ mixin)

कक्षा में एक और वस्तु मिलाएं।

Macroable
स्थिर बूल hasMacro (स्ट्रिंग $ नाम)

मैक्रो पंजीकृत होने पर जांचता है।

Macroable
स्थिर मिश्रित __callStatic (स्ट्रिंग $ विधि, सरणी $ पैरामीटर)

गतिशील रूप से कक्षा में कॉल संभाल लें।

Macroable
मिश्रित __call (स्ट्रिंग $ विधि, सरणी $ पैरामीटर)

गतिशील रूप से कक्षा में कॉल संभाल लें।

Macroable
शून्य __construct (स्ट्रिंग $ नाम, UserProvider प्रदाता $ प्रदाता, Session $ सत्र, अनुरोध $ अनुरोध = शून्य)

एक नया प्रमाणीकरण गार्ड बनाएँ।

Authenticatable | शून्य user ()

वर्तमान में प्रमाणीकृत उपयोगकर्ता प्राप्त करें।

मिश्रित userFromRecaller ($ यादकर्ता याद रखें)

एक उपयोगकर्ता को भंडार से "मुझे याद रखें" कुकी टोकन द्वारा खींचें।

Recaller | शून्य recaller ()

अनुरोध के लिए डिक्रिप्टेड रिमूल्डर कुकी प्राप्त करें।

bool once (सरणी $ credentials = [])

किसी उपयोगकर्ता को सत्र या कुकीज़ के बिना एप्लिकेशन में लॉग इन करें।

bool onceUsingId (मिश्रित $ आईडी)

सत्र या कुकीज़ के बिना आवेदन में दिए गए उपयोगकर्ता आईडी को लॉग इन करें।

bool validate (सरणी $ credentials = [])

उपयोगकर्ता के प्रमाण-पत्रों को मान्य करें।

प्रतिक्रिया | अशक्त basic (स्ट्रिंग $ फ़ील्ड = 'ईमेल', सरणी $ अतिरिक्त कंडीशन = [])

HTTP बेसिक ऑथ का उपयोग करके प्रमाणित करने का प्रयास करें।

प्रतिक्रिया | अशक्त onceBasic (स्ट्रिंग $ फ़ील्ड = 'ईमेल', सरणी $ अतिरिक्त कंडीशन = [])

एक स्टेटलेस HTTP मूल लॉगिन प्रयास करें।

bool attemptBasic (अनुरोध $ अनुरोध, स्ट्रिंग $ फ़ील्ड, सरणी $ अतिरिक्त शर्तें = [])

बुनियादी प्रमाणीकरण का उपयोग कर प्रमाणित करने का प्रयास करें।

सरणी basicCredentials (अनुरोध $ अनुरोध, स्ट्रिंग $ फ़ील्ड)

एक HTTP मूल अनुरोध के लिए प्रमाण पत्र सरणी प्राप्त करें।

शून्य failedBasicResponse ()

बुनियादी प्रमाणीकरण के लिए प्रतिक्रिया प्राप्त करें।

bool attempt (सरणी $ credentials = [], बूल $ याद = झूठी)

दिए गए प्रमाण-पत्रों का उपयोग कर उपयोगकर्ता को प्रमाणीकृत करने का प्रयास करें।

bool hasValidCredentials (मिश्रित $ उपयोगकर्ता, सरणी $ प्रमाण पत्र)

निर्धारित करें कि उपयोगकर्ता क्रेडेंशियल्स से मेल खाता है या नहीं।

Authenticatable loginUsingId (मिश्रित $ आईडी, बूल $ याद = झूठा)

आवेदन में दी गई उपयोगकर्ता आईडी लॉग करें।

शून्य login ( Authenticatable उपयोगकर्ता $, बूल $ याद = झूठा)

एप्लिकेशन में एप्लिकेशन को लॉग इन करें।

शून्य updateSession (स्ट्रिंग $ आईडी)

दिए गए आईडी के साथ सत्र अपडेट करें।

शून्य ensureRememberTokenIsSet ( Authenticatable उपयोगकर्ता)

यदि कोई पहले से मौजूद नहीं है तो उपयोगकर्ता के लिए नया "मुझे याद रखें" टोकन बनाएं।

शून्य queueRecallerCookie ( Authenticatable उपयोगकर्ता)

कुकी जार में रिमूटर कुकी को कतार दें।

कुकी createRecaller (स्ट्रिंग $ मान)

किसी दिए गए आईडी के लिए "मुझे याद रखें" कुकी बनाएं।

शून्य logout ()

एप्लिकेशन को एप्लिकेशन से लॉग आउट करें।

शून्य clearUserDataFromStorage ()

सत्र और कुकीज़ से उपयोगकर्ता डेटा हटा दें।

शून्य cycleRememberToken ( Authenticatable उपयोगकर्ता)

उपयोगकर्ता के लिए "मुझे याद रखें" टोकन रीफ्रेश करें।

शून्य attempting (मिश्रित $ कॉलबैक)

एक प्रमाणीकरण प्रयास घटना श्रोता रजिस्टर करें।

शून्य fireAttemptEvent (सरणी $ प्रमाण पत्र, बूल $ याद = झूठी)

तर्क के साथ प्रयास घटना को फायर करें।

शून्य fireLoginEvent ( Authenticatable उपयोगकर्ता उपयोगकर्ता, बूल $ याद = झूठा)

प्रेषक सेट होने पर लॉगिन ईवेंट को फायर करें।

शून्य fireAuthenticatedEvent ( Authenticatable उपयोगकर्ता)

अगर प्रेषक सेट किया गया है तो प्रमाणित घटना को फायर करें।

शून्य fireFailedEvent ( Authenticatable | शून्य $ उपयोगकर्ता, सरणी $ प्रमाण पत्र)

दिए गए तर्कों के साथ विफल प्रमाणीकरण प्रयास ईवेंट को फायर करें।

Authenticatable getLastAttempted ()

अंतिम उपयोगकर्ता प्राप्त करें जिसे हमने प्रमाणित करने का प्रयास किया था।

तार getName ()

ऑथ सत्र मान के लिए एक अद्वितीय पहचानकर्ता प्राप्त करें।

तार getRecallerName ()

"रिमूटर" को स्टोर करने के लिए उपयोग की जाने वाली कुकी का नाम प्राप्त करें।

bool viaRemember ()

निर्धारित करें कि उपयोगकर्ता को "मुझे याद रखें" कुकी के माध्यम से प्रमाणित किया गया था या नहीं।

QueueingFactory getCookieJar ()

गार्ड द्वारा उपयोग की जाने वाली कुकी निर्माता उदाहरण प्राप्त करें।

शून्य setCookieJar ( QueueingFactory $ कुकी)

गार्ड द्वारा उपयोग की जाने वाली कुकी निर्माता उदाहरण सेट करें।

Dispatcher getDispatcher ()

घटना प्रेषक उदाहरण प्राप्त करें।

शून्य setDispatcher ( setDispatcher $ घटनाओं)

घटना प्रेषक उदाहरण सेट करें।

Session getSession ()

गार्ड द्वारा इस्तेमाल सत्र स्टोर प्राप्त करें।

Authenticatable | शून्य getUser ()

वर्तमान में कैश किए गए उपयोगकर्ता को वापस करें।

निवेदन getRequest ()

वर्तमान अनुरोध उदाहरण प्राप्त करें।

इस $ setRequest (अनुरोध $ अनुरोध)

वर्तमान अनुरोध उदाहरण सेट करें।

विवरण

Authenticatable प्रमाणीकरण ()

निर्धारित करें कि वर्तमान उपयोगकर्ता प्रमाणीकृत है या नहीं।

प्रतिलाभ की मात्रा

Authenticatable

अपवाद

AuthenticationException

बूल चेक ()

निर्धारित करें कि वर्तमान उपयोगकर्ता प्रमाणीकृत है या नहीं।

प्रतिलाभ की मात्रा

bool

बूल अतिथि ()

निर्धारित करें कि वर्तमान उपयोगकर्ता अतिथि है या नहीं।

प्रतिलाभ की मात्रा

bool

int | शून्य आईडी ()

वर्तमान में प्रमाणीकृत उपयोगकर्ता के लिए आईडी प्राप्त करें।

प्रतिलाभ की मात्रा

पूर्णांक | अशक्त

शून्य सेट यूज़र ( Authenticatable उपयोगकर्ता)

वर्तमान उपयोगकर्ता सेट करें।

पैरामीटर

Authenticatable उपयोगकर्ता $

प्रतिलाभ की मात्रा

शून्य

UserProvider getProvider ()

गार्ड द्वारा उपयोग किए जाने वाले उपयोगकर्ता प्रदाता को प्राप्त करें।

प्रतिलाभ की मात्रा

UserProvider

शून्य सेटप्रोवाइडर ( UserProvider प्रदाता $ प्रदाता)

गार्ड द्वारा उपयोग किए जाने वाले उपयोगकर्ता प्रदाता को सेट करें।

पैरामीटर

UserProvider $ प्रदाता

प्रतिलाभ की मात्रा

शून्य

स्थैतिक शून्य मैक्रो (स्ट्रिंग $ नाम, ऑब्जेक्ट | कॉल करने योग्य $ मैक्रो)

एक कस्टम मैक्रो पंजीकृत करें।

पैरामीटर

तार $ नाम
वस्तु | प्रतिदेय $ मैक्रो

प्रतिलाभ की मात्रा

शून्य

स्थैतिक शून्य मिश्रण (ऑब्जेक्ट $ mixin)

कक्षा में एक और वस्तु मिलाएं।

पैरामीटर

वस्तु $ mixin

प्रतिलाभ की मात्रा

शून्य

स्थिर बूल है मैक्रो (स्ट्रिंग $ नाम)

मैक्रो पंजीकृत होने पर जांचता है।

पैरामीटर

तार $ नाम

प्रतिलाभ की मात्रा

bool

स्थैतिक मिश्रित __callStatic (स्ट्रिंग $ विधि, सरणी $ पैरामीटर)

गतिशील रूप से कक्षा में कॉल संभाल लें।

पैरामीटर

तार $ विधि
सरणी $ मानकों

प्रतिलाभ की मात्रा

मिश्रित

अपवाद

BadMethodCallException

मिश्रित __call (स्ट्रिंग $ विधि, सरणी $ पैरामीटर)

गतिशील रूप से कक्षा में कॉल संभाल लें।

पैरामीटर

तार $ विधि
सरणी $ मानकों

प्रतिलाभ की मात्रा

मिश्रित

अपवाद

BadMethodCallException

शून्य __construct (स्ट्रिंग $ नाम, UserProvider प्रदाता $ प्रदाता, Session $ सत्र, अनुरोध $ अनुरोध = शून्य)

एक नया प्रमाणीकरण गार्ड बनाएँ।

पैरामीटर

तार $ नाम
UserProvider $ प्रदाता
Session $ सत्र
निवेदन $ अनुरोध

प्रतिलाभ की मात्रा

शून्य

Authenticatable | शून्य उपयोगकर्ता ()

वर्तमान में प्रमाणीकृत उपयोगकर्ता प्राप्त करें।

प्रतिलाभ की मात्रा

Authenticatable | शून्य

संरक्षित मिश्रित उपयोगकर्ता FromRecaller ($ $ यादकर्ता याद)

एक उपयोगकर्ता को भंडार से "मुझे याद रखें" कुकी टोकन द्वारा खींचें।

पैरामीटर

Recaller $ recaller

प्रतिलाभ की मात्रा

मिश्रित

संरक्षित Recaller | शून्य यादकर्ता ()

अनुरोध के लिए डिक्रिप्टेड रिमूल्डर कुकी प्राप्त करें।

प्रतिलाभ की मात्रा

Recaller | शून्य

एक बार बूल (सरणी $ credentials = [])

किसी उपयोगकर्ता को सत्र या कुकीज़ के बिना एप्लिकेशन में लॉग इन करें।

पैरामीटर

सरणी $ साख

प्रतिलाभ की मात्रा

bool

एक बार UsingId (मिश्रित $ आईडी)

सत्र या कुकीज़ के बिना आवेदन में दिए गए उपयोगकर्ता आईडी को लॉग इन करें।

पैरामीटर

मिश्रित $ आईडी

प्रतिलाभ की मात्रा

bool

बूल मान्य (सरणी $ credentials = [])

उपयोगकर्ता के प्रमाण-पत्रों को मान्य करें।

पैरामीटर

सरणी $ साख

प्रतिलाभ की मात्रा

bool

प्रतिक्रिया | शून्य मूल (स्ट्रिंग $ फ़ील्ड = 'ईमेल', सरणी $ अतिरिक्त कंडीशन = [])

HTTP बेसिक ऑथ का उपयोग करके प्रमाणित करने का प्रयास करें।

पैरामीटर

तार $ क्षेत्र
सरणी $ extraConditions

प्रतिलाभ की मात्रा

प्रतिक्रिया | अशक्त

प्रतिक्रिया | शून्य एक बार बेसिक (स्ट्रिंग $ फ़ील्ड = 'ईमेल', सरणी $ अतिरिक्त कंडीशन = [])

एक स्टेटलेस HTTP मूल लॉगिन प्रयास करें।

पैरामीटर

तार $ क्षेत्र
सरणी $ extraConditions

प्रतिलाभ की मात्रा

प्रतिक्रिया | अशक्त

सुरक्षित बूल प्रयास बासिक (अनुरोध $ अनुरोध, स्ट्रिंग $ फ़ील्ड, सरणी $ अतिरिक्त शर्तें = [])

बुनियादी प्रमाणीकरण का उपयोग कर प्रमाणित करने का प्रयास करें।

पैरामीटर

निवेदन $ अनुरोध
तार $ क्षेत्र
सरणी $ extraConditions

प्रतिलाभ की मात्रा

bool

संरक्षित सरणी बुनियादी प्रमाणपत्र (अनुरोध $ अनुरोध, स्ट्रिंग $ फ़ील्ड)

एक HTTP मूल अनुरोध के लिए प्रमाण पत्र सरणी प्राप्त करें।

पैरामीटर

निवेदन $ अनुरोध
तार $ क्षेत्र

प्रतिलाभ की मात्रा

सरणी

संरक्षित शून्य विफल BasicResponse ()

बुनियादी प्रमाणीकरण के लिए प्रतिक्रिया प्राप्त करें।

प्रतिलाभ की मात्रा

शून्य

अपवाद

UnauthorizedHttpException

बूल प्रयास (सरणी $ credentials = [], बूल $ याद = झूठी)

दिए गए प्रमाण-पत्रों का उपयोग कर उपयोगकर्ता को प्रमाणीकृत करने का प्रयास करें।

पैरामीटर

सरणी $ साख
bool $ याद

प्रतिलाभ की मात्रा

bool

संरक्षित बूल के पास वैध प्रमाणीकरण (मिश्रित $ उपयोगकर्ता, सरणी $ प्रमाण-पत्र)

निर्धारित करें कि उपयोगकर्ता क्रेडेंशियल्स से मेल खाता है या नहीं।

पैरामीटर

मिश्रित उपयोगकर्ता $
सरणी $ साख

प्रतिलाभ की मात्रा

bool

Authenticatable लॉगिनUsingId (मिश्रित $ आईडी, बूल $ याद = झूठी)

आवेदन में दी गई उपयोगकर्ता आईडी लॉग करें।

पैरामीटर

मिश्रित $ आईडी
bool $ याद

प्रतिलाभ की मात्रा

Authenticatable

शून्य लॉगिन ( Authenticatable उपयोगकर्ता उपयोगकर्ता, बूल $ याद = झूठा)

एप्लिकेशन में एप्लिकेशन को लॉग इन करें।

पैरामीटर

Authenticatable उपयोगकर्ता $
bool $ याद

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य अद्यतन सत्र (स्ट्रिंग $ आईडी)

दिए गए आईडी के साथ सत्र अपडेट करें।

पैरामीटर

तार $ आईडी

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य सुनिश्चित करें RememberTokenIsSet ( Authenticatable उपयोगकर्ता)

यदि कोई पहले से मौजूद नहीं है तो उपयोगकर्ता के लिए नया "मुझे याद रखें" टोकन बनाएं।

पैरामीटर

Authenticatable उपयोगकर्ता $

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य queueRecallerCookie ( Authenticatable $ उपयोगकर्ता)

कुकी जार में रिमूटर कुकी को कतार दें।

पैरामीटर

Authenticatable उपयोगकर्ता $

प्रतिलाभ की मात्रा

शून्य

संरक्षित कुकी createRecaller (स्ट्रिंग $ मूल्य)

किसी दिए गए आईडी के लिए "मुझे याद रखें" कुकी बनाएं।

पैरामीटर

तार $ मूल्य

प्रतिलाभ की मात्रा

कुकी

शून्य लॉगआउट ()

एप्लिकेशन को एप्लिकेशन से लॉग आउट करें।

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य clearUserDataFromStorage ()

सत्र और कुकीज़ से उपयोगकर्ता डेटा हटा दें।

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य चक्र यादगार टोकन ( Authenticatable उपयोगकर्ता)

उपयोगकर्ता के लिए "मुझे याद रखें" टोकन रीफ्रेश करें।

पैरामीटर

Authenticatable उपयोगकर्ता $

प्रतिलाभ की मात्रा

शून्य

शून्य प्रयास (मिश्रित $ कॉलबैक)

एक प्रमाणीकरण प्रयास घटना श्रोता रजिस्टर करें।

पैरामीटर

मिश्रित $ कॉलबैक

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य आगAttemptEvent (सरणी $ प्रमाण पत्र, बूल $ याद = झूठी)

तर्क के साथ प्रयास घटना को फायर करें।

पैरामीटर

सरणी $ साख
bool $ याद

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य आग LoginEvent ( Authenticatable उपयोगकर्ता उपयोगकर्ता, बूल $ याद = झूठा)

प्रेषक सेट होने पर लॉगिन ईवेंट को फायर करें।

पैरामीटर

Authenticatable उपयोगकर्ता $
bool $ याद

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य आग Authenticatable Event ( Authenticatable उपयोगकर्ता)

अगर प्रेषक सेट किया गया है तो प्रमाणित घटना को फायर करें।

पैरामीटर

Authenticatable उपयोगकर्ता $

प्रतिलाभ की मात्रा

शून्य

संरक्षित शून्य फायरफेलएवेंट ( Authenticatable | शून्य $ उपयोगकर्ता, सरणी $ प्रमाण पत्र)

दिए गए तर्कों के साथ विफल प्रमाणीकरण प्रयास ईवेंट को फायर करें।

पैरामीटर

Authenticatable | शून्य उपयोगकर्ता $
सरणी $ साख

प्रतिलाभ की मात्रा

शून्य

Authenticatable LLastAttempted ()

अंतिम उपयोगकर्ता प्राप्त करें जिसे हमने प्रमाणित करने का प्रयास किया था।

प्रतिलाभ की मात्रा

Authenticatable

स्ट्रिंग getName ()

ऑथ सत्र मान के लिए एक अद्वितीय पहचानकर्ता प्राप्त करें।

प्रतिलाभ की मात्रा

तार

स्ट्रिंग getRecallerName ()

"रिमूटर" को स्टोर करने के लिए उपयोग की जाने वाली कुकी का नाम प्राप्त करें।

प्रतिलाभ की मात्रा

तार

बूल के माध्यम से याद रखें ()

निर्धारित करें कि उपयोगकर्ता को "मुझे याद रखें" कुकी के माध्यम से प्रमाणित किया गया था या नहीं।

प्रतिलाभ की मात्रा

bool

QueueingFactory getCookieJar ()

गार्ड द्वारा उपयोग की जाने वाली कुकी निर्माता उदाहरण प्राप्त करें।

प्रतिलाभ की मात्रा

QueueingFactory

अपवाद

RuntimeException

शून्य सेटकुकीज ( QueueingFactory $ कुकी)

गार्ड द्वारा उपयोग की जाने वाली कुकी निर्माता उदाहरण सेट करें।

पैरामीटर

QueueingFactory $ कुकी

प्रतिलाभ की मात्रा

शून्य

Dispatcher getDispatcher ()

घटना प्रेषक उदाहरण प्राप्त करें।

प्रतिलाभ की मात्रा

Dispatcher

शून्य सेट Dispatcher ( Dispatcher $ घटनाएं)

घटना प्रेषक उदाहरण सेट करें।

पैरामीटर

Dispatcher $ घटनाओं

प्रतिलाभ की मात्रा

शून्य

Session प्राप्त Session ()

गार्ड द्वारा इस्तेमाल सत्र स्टोर प्राप्त करें।

प्रतिलाभ की मात्रा

Session

Authenticatable | शून्य getUser ()

वर्तमान में कैश किए गए उपयोगकर्ता को वापस करें।

प्रतिलाभ की मात्रा

Authenticatable | शून्य

अनुरोध प्राप्त करें अनुरोध ()

वर्तमान अनुरोध उदाहरण प्राप्त करें।

प्रतिलाभ की मात्रा

निवेदन

$ this setRequest ($ अनुरोध का अनुरोध करें)

वर्तमान अनुरोध उदाहरण सेट करें।

पैरामीटर

निवेदन $ अनुरोध

प्रतिलाभ की मात्रा

इस $