Symfony 4.1

AbstractController




symfony

AbstractController

अमूर्त वर्ग AbstractController लागू करता है ServiceSubscriberInterface

नियंत्रकों में आवश्यक सामान्य सुविधाएँ प्रदान करता है।

लक्षण

ControllerTrait नियंत्रकों में आवश्यक सामान्य सुविधाएँ।

गुण

संरक्षित कंटेनरइंटरफेस $ कंटेनर

तरीके

bool has (स्ट्रिंग $ आईडी)

यदि सेवा आईडी परिभाषित है, तो सही है।

ControllerTrait
वस्तु get (स्ट्रिंग $ आईडी)

अपनी आईडी द्वारा कंटेनर सेवा प्राप्त करता है।

ControllerTrait
तार generateUrl (स्ट्रिंग $ मार्ग, सरणी $ पैरामीटर = सरणी (), int $ referenceType = UrlGeneratorInterface :: ABSOLUTE_PATH)

दिए गए मापदंडों में से एक URL बनाता है।

ControllerTrait
Response forward (स्ट्रिंग $ नियंत्रक, सरणी $ पथ = सरणी) (, सरणी $ क्वेरी = सरणी ())

दूसरे नियंत्रक से अनुरोध के लिए आगे।

ControllerTrait
RedirectResponse redirect (स्ट्रिंग $ url, int $ स्थिति = 302)

दिए गए URL पर एक पुनर्निर्देशन लौटाता है।

ControllerTrait
RedirectResponse redirectToRoute (स्ट्रिंग $ मार्ग, सरणी $ पैरामीटर = सरणी (), इंट $ स्थिति = 302)

दिए गए मापदंडों के साथ दिए गए मार्ग पर एक पुनर्निर्देशन लौटाता है।

ControllerTrait
JsonResponse json ($ data, int $ status = 200, array $ headers = array (), array $ reference = array ())

यदि सक्षम, या json_encode धारावाहिक घटक का उपयोग करता है कि एक JsonResponse देता है।

ControllerTrait
BinaryFileResponse file ($ फ़ाइल, स्ट्रिंग $ fileName = null, स्ट्रिंग $ स्वभाव = ResponseHeaderBag :: DISPOSITION_ATTACHMENT)

मूल या अनुकूलित फ़ाइल नाम और स्वभाव हेडर के साथ एक BinaryFileResponse ऑब्जेक्ट देता है।

ControllerTrait
addFlash (स्ट्रिंग $ प्रकार, स्ट्रिंग $ संदेश)

प्रकार के लिए वर्तमान सत्र के लिए एक फ्लैश संदेश जोड़ता है।

ControllerTrait
bool isGranted ($ विशेषताएँ, $ विषय = अशक्त)

जाँचता है कि क्या विशेषताएँ वर्तमान प्रमाणीकरण टोकन और वैकल्पिक रूप से आपूर्ति किए गए विषय के विरुद्ध दी गई हैं।

ControllerTrait
denyAccessUnlessGranted ($ विशेषताएँ, $ विषय = अशक्त, स्ट्रिंग $ संदेश = 'पहुंच अस्वीकृत'।)

जब तक वर्तमान प्रमाणीकरण टोकन और वैकल्पिक रूप से आपूर्ति किए गए विषय के विरुद्ध विशेषता प्रदान नहीं की जाती है तब तक एक अपवाद फेंकता है।

ControllerTrait
तार renderView (स्ट्रिंग $ दृश्य, सरणी $ पैरामीटर = सरणी ())

एक गाया हुआ दृश्य लौटाता है।

ControllerTrait
Response render (स्ट्रिंग $ दृश्य, सरणी $ पैरामीटर = सरणी (), Response $ प्रतिक्रिया = नल)

एक दृश्य प्रस्तुत करता है।

ControllerTrait
StreamedResponse stream (स्ट्रिंग $ दृश्य, सरणी $ पैरामीटर = सरणी (), StreamedResponse $ प्रतिक्रिया = नल)

एक दृश्य धाराओं।

ControllerTrait
NotFoundHttpException createNotFoundException (string $ message = 'Not Found', Exception $ $ = null)

एक NotFoundHttpException देता है।

ControllerTrait
AccessDeniedException createAccessDeniedException (स्ट्रिंग $ संदेश = 'पहुंच अस्वीकृत', Exception $ पिछले = शून्य)

एक AccessDeniedException देता है।

ControllerTrait
FormInterface createForm (स्ट्रिंग $ प्रकार, $ डेटा = शून्य, सरणी $ विकल्प = सरणी ())

प्रपत्र के प्रकार से प्रपत्र आवृत्ति बनाता और वापस करता है।

ControllerTrait
FormBuilderInterface createFormBuilder ($ डेटा = शून्य, सरणी $ विकल्प = सरणी ())

एक फार्म बिल्डर उदाहरण बनाता है और लौटाता है।

ControllerTrait
ManagerRegistry getDoctrine ()

Doctrine रजिस्ट्री सेवा को वापस करने के लिए शॉर्टकट।

ControllerTrait
मिश्रित getUser ()

सुरक्षा टोकन संग्रहण से उपयोगकर्ता प्राप्त करें।

ControllerTrait
bool isCsrfTokenValid (स्ट्रिंग $ id, string | null $ टोकन)

CSRF टोकन की वैधता की जाँच करता है।

ControllerTrait
dispatchMessage (ऑब्जेक्ट $ संदेश)

बस के लिए एक संदेश भेजता है।

ControllerTrait
setContainer ( setContainer $ कंटेनर)
मिश्रित getParameter (स्ट्रिंग $ नाम)

अपने नाम से एक कंटेनर पैरामीटर प्राप्त करता है।

स्थिर सरणी getSubscribedServices ()

ऐसे उदाहरणों के लिए आवश्यक सेवा प्रकारों की एक सरणी लौटाता है, आंतरिक रूप से उपयोग किए जाने वाले सेवा नामों द्वारा वैकल्पिक रूप से कुंजीबद्ध होता है।

विवरण

संरक्षित बूल में (स्ट्रिंग $ आईडी) है

यदि सेवा आईडी परिभाषित है, तो सही है।

पैरामीटर

तार $ आईडी

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

bool

संरक्षित वस्तु प्राप्त (स्ट्रिंग $ आईडी)

अपनी आईडी द्वारा कंटेनर सेवा प्राप्त करता है।

पैरामीटर

तार $ आईडी

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

वस्तु सेवा

संरक्षित स्ट्रिंग जेनरेट्ल (स्ट्रिंग $ मार्ग, सरणी $ पैरामीटर = सरणी) (, int $ referenceType = UrlGeneratorInterface :: ABSOLUTE_PATH)

दिए गए मापदंडों में से एक URL बनाता है।

पैरामीटर

तार $ मार्ग
सरणी $ मानकों
पूर्णांक $ referenceType

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

तार

यह भी देखें

UrlGeneratorInterface

संरक्षित Response आगे (स्ट्रिंग $ नियंत्रक, सरणी $ पथ = सरणी (), सरणी $ क्वेरी = सरणी ())

दूसरे नियंत्रक से अनुरोध के लिए आगे।

पैरामीटर

तार $ नियंत्रक
सरणी $ पथ
सरणी $ क्वेरी

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

Response

संरक्षित RedirectResponse पुनर्निर्देशित (स्ट्रिंग $ url, int $ स्थिति = 302)

दिए गए URL पर एक पुनर्निर्देशन लौटाता है।

पैरामीटर

तार $ url
पूर्णांक $ स्थिति

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

RedirectResponse

संरक्षित RedirectResponse redirectToRoute (स्ट्रिंग $ मार्ग, सरणी $ पैरामीटर = सरणी) (, इंट $ स्टेटस / 30%)

दिए गए मापदंडों के साथ दिए गए मार्ग पर एक पुनर्निर्देशन लौटाता है।

पैरामीटर

तार $ मार्ग
सरणी $ मानकों
पूर्णांक $ स्थिति

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

RedirectResponse

संरक्षित JsonResponse json ($ data, int $ status = 200, array $ headers = array (), array $ JsonResponse = array ())

यदि सक्षम, या json_encode धारावाहिक घटक का उपयोग करता है कि एक JsonResponse देता है।

पैरामीटर

$ डेटा
पूर्णांक $ स्थिति
सरणी $ हेडर
सरणी $ संदर्भ

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

JsonResponse

संरक्षित BinaryFileResponse फ़ाइल ($ फ़ाइल, स्ट्रिंग $ fileName = null, स्ट्रिंग $ स्वभाव = ResponseHeaderBag :: DISPOSITION_ATTACHMENT)

मूल या अनुकूलित फ़ाइल नाम और स्वभाव हेडर के साथ एक BinaryFileResponse ऑब्जेक्ट देता है।

पैरामीटर

$ फ़ाइल
तार $ fileName
तार $ स्वभाव

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

BinaryFileResponse

संरक्षित एडफ़्लैश (स्ट्रिंग $ प्रकार, स्ट्रिंग $ संदेश)

प्रकार के लिए वर्तमान सत्र के लिए एक फ्लैश संदेश जोड़ता है।

पैरामीटर

तार $ प्रकार
तार $ संदेश

अपवाद

LogicException

संरक्षित बछेड़ी ($ विशेषताएँ, $ विषय = अशक्त) है

जाँचता है कि क्या विशेषताएँ वर्तमान प्रमाणीकरण टोकन और वैकल्पिक रूप से आपूर्ति किए गए विषय के विरुद्ध दी गई हैं।

पैरामीटर

$ गुण
$ विषय

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

bool

अपवाद

LogicException

संरक्षित denyAccessUnlessGranted ($ विशेषताएँ, $ विषय = अशक्त, स्ट्रिंग $ संदेश = 'पहुंच अस्वीकृत।)

जब तक वर्तमान प्रमाणीकरण टोकन और वैकल्पिक रूप से आपूर्ति किए गए विषय के विरुद्ध विशेषता प्रदान नहीं की जाती है तब तक एक अपवाद फेंकता है।

पैरामीटर

$ गुण
$ विषय
तार $ संदेश

अपवाद

AccessDeniedException

संरक्षित स्ट्रिंग रेंडर व्यू (स्ट्रिंग $ दृश्य, सरणी $ पैरामीटर = सरणी ())

एक गाया हुआ दृश्य लौटाता है।

पैरामीटर

तार $ दृश्य
सरणी $ मानकों

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

तार

संरक्षित Response रेंडर (स्ट्रिंग $ दृश्य, सरणी $ पैरामीटर = सरणी (), Response $ प्रतिक्रिया = रिक्त)

एक दृश्य प्रस्तुत करता है।

पैरामीटर

तार $ दृश्य
सरणी $ मानकों
Response $ प्रतिक्रिया

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

Response

संरक्षित StreamedResponse स्ट्रीम (स्ट्रिंग $ व्यू, एरे $ पैरामीटर = एरे (), StreamedResponse $ रेस्पॉन्स = नल)

एक दृश्य धाराओं।

पैरामीटर

तार $ दृश्य
सरणी $ मानकों
StreamedResponse $ प्रतिक्रिया

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

StreamedResponse

संरक्षित NotFoundHttpException createNotFoundException (स्ट्रिंग $ संदेश = 'नहीं मिला', Exception $ पिछला = सुस्त)

एक NotFoundHttpException देता है।

इसके परिणामस्वरूप 404 प्रतिक्रिया कोड होगा। उपयोग उदाहरण:

throw $this->createNotFoundException('Page not found!');

पैरामीटर

तार $ संदेश
Exception $ पिछले

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

NotFoundHttpException

संरक्षित AccessDeniedException बनाएँ

एक AccessDeniedException देता है।

इसके परिणामस्वरूप 403 प्रतिक्रिया कोड होगा। उपयोग उदाहरण:

throw $this->createAccessDeniedException('Unable to access this page!');

पैरामीटर

तार $ संदेश
Exception $ पिछले

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

AccessDeniedException

अपवाद

LogicException यदि सुरक्षा घटक उपलब्ध नहीं है

संरक्षित FormInterface createForm (स्ट्रिंग $ प्रकार, $ डेटा = अशक्त, सरणी $ विकल्प = सरणी ())

प्रपत्र के प्रकार से प्रपत्र आवृत्ति बनाता और वापस करता है।

पैरामीटर

तार $ प्रकार
$ डेटा
सरणी $ विकल्प

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

FormInterface

संरक्षित FormBuilderInterface createFormBuilder ($ डेटा = शून्य, सरणी $ विकल्प = सरणी ())

एक फार्म बिल्डर उदाहरण बनाता है और लौटाता है।

पैरामीटर

$ डेटा
सरणी $ विकल्प

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

FormBuilderInterface

संरक्षित प्रबंधकरजेंसी getDoctrine ()

Doctrine रजिस्ट्री सेवा को वापस करने के लिए शॉर्टकट।

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

ManagerRegistry

अपवाद

LogicException यदि DoctrineBundle उपलब्ध नहीं है

संरक्षित मिश्रित गेटउज़र ()

सुरक्षा टोकन संग्रहण से उपयोगकर्ता प्राप्त करें।

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

मिश्रित

अपवाद

LogicException यदि SecurityBundle उपलब्ध नहीं है

यह भी देखें

TokenInterface :: getUser ()

संरक्षित बूल isCsrfTokenValid (स्ट्रिंग $ id, string | null $ token)

CSRF टोकन की वैधता की जाँच करता है।

पैरामीटर

तार $ आईडी टोकन बनाते समय उपयोग की जाने वाली आईडी
स्ट्रिंग | अशक्त $ टोकन उस अनुरोध के साथ भेजे गए वास्तविक टोकन को मान्य किया जाना चाहिए

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

bool

संरक्षित प्रेषण। (वस्तु $ संदेश)

बस के लिए एक संदेश भेजता है।

पैरामीटर

वस्तु $ संदेश भेजने का संदेश

सेटकंटेनर (कंटेनरइंटरफेस $ कंटेनर)

पैरामीटर

ContainerInterface $ कंटेनर

संरक्षित मिश्रित getParameter (स्ट्रिंग $ नाम)

अपने नाम से एक कंटेनर पैरामीटर प्राप्त करता है।

पैरामीटर

तार $ नाम

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

मिश्रित

स्थिर सरणी getSubscribedServices ()

ऐसे उदाहरणों के लिए आवश्यक सेवा प्रकारों की एक सरणी लौटाता है, आंतरिक रूप से उपयोग किए जाने वाले सेवा नामों द्वारा वैकल्पिक रूप से कुंजीबद्ध होता है।

अनिवार्य निर्भरता के लिए:

  • सरणी ('लकड़हारा' => 'Psr \ Log \ LoggerInterface') का अर्थ है कि वस्तुएं "लकड़हारा" नाम का उपयोग आंतरिक रूप से एक सेवा लाने के लिए करती हैं जिसे Psr \ Log \ LoggerInterface को लागू करना चाहिए।
  • सरणी ('Psr \ Log \ LoggerInterface') के लिए एक शॉर्टकट है
  • सरणी ('Psr \ Log \ LoggerInterface' => 'Psr \ Log \ LoggerInterface')

अन्यथा:

  • सरणी ('लकड़हारा' => '; Psr \ Log \ LoggerInterface') एक वैकल्पिक निर्भरता को दर्शाता है
  • सरणी ('; Psr \ Log \ LoggerInterface') के लिए एक शॉर्टकट है
  • सरणी ('Psr \ Log \ LoggerInterface' => '; Psr \ Log \ LoggerInterface')

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

सरणी आवश्यक सेवा प्रकार, वैकल्पिक रूप से सेवा नामों द्वारा कुंजीबद्ध