Symfony 4.1

Router




symfony

Router

क्लास राउटर Router WarmableInterface , WarmableInterface बढ़ाता है

यह राउटर कैश लोड होने पर ही लोडर बनाता है।

गुण

संरक्षित UrlMatcherInterface | अशक्त | $ मिलान Router
संरक्षित UrlGeneratorInterface | अशक्त | $ जनरेटर Router
संरक्षित RequestContext $ संदर्भ Router
रक्षित LoaderInterface $ लोडर Router
रक्षित RouteCollection | नल | $ संग्रह Router
संरक्षित मिश्रित $ संसाधन Router
संरक्षित सरणी $ विकल्प Router
संरक्षित लॉगरइंटरफेस | null $ लकड़हारा Router

तरीके

__construct ( __construct $ कंटेनर, मिश्रित $ संसाधन, सरणी $ विकल्प = सरणी (), RequestContext $ संदर्भ = शून्य, कंटेनरइंटरफेस $ पैरामीटर = नल, लॉगरइंटरफेस $ लकड़हारा = सुस्त)
setOptions (सरणी $ विकल्प)

विकल्प सेट करता है।

Router
setOption (स्ट्रिंग $ कुंजी, मिश्रित $ मूल्य)

एक विकल्प सेट करता है।

Router
मिश्रित getOption (स्ट्रिंग $ कुंजी)

एक विकल्प मूल्य हो जाता है।

Router
RouteCollection getRouteCollection ()

इस राउटर से जुड़े रूटकॉलिनेशन उदाहरण को प्राप्त करता है।

setContext ( RequestContext $ संदर्भ)

अनुरोध संदर्भ सेट करता है।

Router
RequestContext getContext ()

अनुरोध प्रसंग मिलता है।

Router
setConfigCacheFactory ( ConfigCacheFactoryInterface $ configCacheFactory)

उपयोग करने के लिए कॉन्फ़िगैचे कारखाने को सेट करता है।

Router
तार generate (स्ट्रिंग $ नाम, मिश्रित $ पैरामीटर = सरणी (), int $ referenceType = self :: ABSOLUTE_PATH)

दिए गए मापदंडों के आधार पर एक विशिष्ट मार्ग के लिए एक URL या पथ बनाता है।

Router
सरणी match (स्ट्रिंग $ pathinfo)

मार्गों के एक सेट के साथ एक URL पथ से मिलान करने की कोशिश करता है।

Router
सरणी matchRequest ( Request $ अनुरोध)

मार्गों के एक सेट के साथ एक अनुरोध का मिलान करने की कोशिश करता है।

Router
UrlMatcherInterface getMatcher ()

इस राउटर के साथ जुड़े UrlMatcher उदाहरण हो जाता है।

Router
UrlGeneratorInterface getGenerator ()

इस राउटर से जुड़े UrlGenerator इंस्टेंस को प्राप्त करता है।

Router
addExpressionLanguageProvider ( ExpressionFunctionProviderInterface $ प्रदाता) Router
GeneratorDumperInterface getGeneratorDumperInstance () Router
MatcherDumperInterface getMatcherDumperInstance () Router
warmUp (स्ट्रिंग $ कैशडिर)

कैश को चेतावनी देता है।

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

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

विवरण

__construct (कंटेनरइंटरफेस $ कंटेनर, मिश्रित $ संसाधन, सरणी $ विकल्प = सरणी (), RequestContext $ संदर्भ = शून्य, कंटेनरइंटरफेस $ पैरामीटर = नल, लॉगरइंटरफेस $ लकड़हारा = सुस्त)

पैरामीटर

ContainerInterface $ कंटेनर एक कंटेनरइंटरफेस उदाहरण
मिश्रित $ संसाधन लोड करने के लिए मुख्य संसाधन
सरणी $ विकल्प विकल्पों की एक सरणी
RequestContext $ संदर्भ प्रसंग
ContainerInterface $ मानकों कंटेनरों को लाने के लिए एक कंटेनरइंटरफेस उदाहरण
LoggerInterface $ लकड़हारा एक लकड़हारा उदाहरण

setOptions (सरणी $ विकल्प)

विकल्प सेट करता है।

उपलब्ध विकल्प:

  • cache_dir: कैश निर्देशिका (या कैशिंग अक्षम करने के लिए अशक्त)
  • डीबग करें: डिबगिंग सक्षम करें या नहीं (डिफ़ॉल्ट रूप से गलत)
  • जनरेटर_क्लास: एक अर्लगेंनेटरइंटरफेस कार्यान्वयन का नाम
  • जनरेटर_बेस_क्लास: डंप किए गए जनरेटर वर्ग के लिए आधार वर्ग
  • जनरेटर_कैश_क्लास: डंप किए गए जनरेटर वर्ग का वर्ग नाम
  • जनरेटर_डंपर_क्लास: एक जेनरेटरडम्परइंटरफेस कार्यान्वयन का नाम
  • matcher_class: एक UrlMatcherInterface कार्यान्वयन का नाम
  • matcher_base_class: डंप किए गए मिलानकर्ता वर्ग के लिए आधार वर्ग
  • matcher_dumper_class: डंप किए गए मिलानकर्ता वर्ग का वर्ग नाम
  • matcher_cache_class: एक MatcherDumperInterface कार्यान्वयन का नाम
  • resource_type: मुख्य संसाधन के लिए टाइप करें संकेत (वैकल्पिक)
  • hard_requirements: कॉन्फ़िगर करने योग्यRequirementsInterface को लागू करने वाले जनरेटर के लिए सख्त आवश्यकता जाँच कॉन्फ़िगर करें (डिफ़ॉल्ट सत्य है)

पैरामीटर

सरणी $ विकल्प विकल्पों की एक सरणी

अपवाद

InvalidArgumentException जब असमर्थित विकल्प प्रदान किया जाता है

सेटओशन (स्ट्रिंग $ कुंजी, मिश्रित $ मूल्य)

एक विकल्प सेट करता है।

पैरामीटर

तार $ कुंजी चाबी
मिश्रित $ मूल्य महत्व

अपवाद

InvalidArgumentException

मिश्रित getOption (स्ट्रिंग $ कुंजी)

एक विकल्प मूल्य हो जाता है।

पैरामीटर

तार $ कुंजी चाबी

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

मिश्रित महत्व

अपवाद

InvalidArgumentException

RouteCollection getRouteCollection ()

इस राउटर से जुड़े रूटकॉलिनेशन उदाहरण को प्राप्त करता है।

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

RouteCollection एक रूटकॉलिनेशन उदाहरण

setContext ( RequestContext $ संदर्भ)

अनुरोध संदर्भ सेट करता है।

पैरामीटर

RequestContext $ संदर्भ

RequestContext getContext ()

अनुरोध प्रसंग मिलता है।

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

RequestContext प्रसंग

setConfigCacheFactory ( ConfigCacheFactoryInterface $ configCacheFactory)

उपयोग करने के लिए विन्यासकैप कारखाने को सेट करता है।

पैरामीटर

ConfigCacheFactoryInterface $ configCacheFactory

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

दिए गए मापदंडों के आधार पर एक विशिष्ट मार्ग के लिए एक URL या पथ बनाता है।

मार्ग पैटर्न में प्लेसहोल्डर का संदर्भ देने वाले पैरामीटर उन्हें पथ या होस्ट में स्थानापन्न करेंगे। अतिरिक्त params को URL में क्वेरी स्ट्रिंग के रूप में जोड़ा जाता है।

जब मार्ग के लिए पारित संदर्भ प्रकार उत्पन्न नहीं किया जा सकता है क्योंकि इसे वर्तमान होस्ट की तुलना में एक अलग होस्ट या योजना की आवश्यकता होती है, तो विधि एक अधिक व्यापक संदर्भ लौटाएगी जिसमें आवश्यक पैरामीटर शामिल हैं। उदाहरण के लिए, जब आप $ रेफ़र टाइप = ABSOLUTE_PATH के साथ इस विधि को कॉल करते हैं, लेकिन रूट को https स्कीम की आवश्यकता होती है, जबकि वर्तमान स्कीम http है, तो इसके बजाय यह ABSOLUTE_URL https स्कीम और वर्तमान होस्ट के साथ वापस आ जाएगी। यह सुनिश्चित करता है कि उत्पन्न URL किसी भी स्थिति में मार्ग से मेल खाता है।

यदि दिए गए नाम के साथ कोई मार्ग नहीं है, तो जनरेटर को रूटनॉटफ़ाउंड एक्ससेप्शन फेंकना चाहिए।

विशेष पैरामीटर _fragment का उपयोग अंतिम URL पर दस्तावेज़ के टुकड़े के रूप में किया जाएगा।

पैरामीटर

तार $ नाम मार्ग का नाम
मिश्रित $ मानकों मापदंडों की एक सरणी
पूर्णांक $ referenceType उत्पन्न होने वाले संदर्भ का प्रकार (स्थिरांक में से एक)

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

तार उत्पन्न URL

अपवाद

RouteNotFoundException यदि नामित मार्ग मौजूद नहीं है
MissingMandatoryParametersException जब कुछ पैरामीटर गायब हैं जो मार्ग के लिए अनिवार्य हैं
InvalidParameterException जब एक प्लेसहोल्डर के लिए एक पैरामीटर मान सही नहीं है क्योंकि यह आवश्यकता से मेल नहीं खाता है

सरणी मिलान (स्ट्रिंग $ pathinfo)

मार्गों के एक सेट के साथ एक URL पथ से मिलान करने की कोशिश करता है।

यदि मिलानकर्ता जानकारी नहीं पा सकता है, तो उसे नीचे दिए गए अपवादों में से एक को फेंकना होगा।

पैरामीटर

तार $ pathinfo पथ की जानकारी पार्स की जानी चाहिए (कच्चा प्रारूप, यानी urldecoded नहीं)

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

सरणी मापदंडों की एक सरणी

अपवाद

NoConfigurationException यदि कोई रूटिंग कॉन्फ़िगरेशन नहीं मिला
ResourceNotFoundException यदि संसाधन नहीं मिल सका
MethodNotAllowedException यदि संसाधन मिल गया था, लेकिन अनुरोध विधि की अनुमति नहीं है

सरणी मिलान (सबसे Request $ अनुरोध)

मार्गों के एक सेट के साथ एक अनुरोध का मिलान करने की कोशिश करता है।

यदि मिलानकर्ता जानकारी नहीं पा सकता है, तो उसे नीचे दिए गए अपवादों में से एक को फेंकना होगा।

पैरामीटर

Request $ अनुरोध

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

सरणी मापदंडों की एक सरणी

अपवाद

NoConfigurationException यदि कोई रूटिंग कॉन्फ़िगरेशन नहीं मिला
ResourceNotFoundException यदि कोई मिलान संसाधन नहीं मिला
MethodNotAllowedException यदि एक मेल संसाधन पाया गया था, लेकिन अनुरोध विधि की अनुमति नहीं है

UrlMatcherInterface getMatcher ()

इस राउटर के साथ जुड़े UrlMatcher उदाहरण हो जाता है।

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

UrlMatcherInterface एक UrlMatcherInterface उदाहरण

UrlGeneratorInterface getGenerator ()

इस राउटर से जुड़े UrlGenerator इंस्टेंस को प्राप्त करता है।

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

UrlGeneratorInterface एक UrlGeneratorInterface उदाहरण

addExpressionLanguageProvider ( ExpressionFunctionProviderInterface $ प्रदाता)

पैरामीटर

ExpressionFunctionProviderInterface $ प्रदाता

संरक्षित जेनरेटरपरेटरइंटरफेस getGeneratorDumperInstance ()

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

GeneratorDumperInterface

सुरक्षित MatcherDumperInterface getMatcherDumperInstance ()

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

MatcherDumperInterface

वार्मअप (स्ट्रिंग $ कैशडिर)

कैश को चेतावनी देता है।

पैरामीटर

तार $ cacheDir कैश निर्देशिका

स्थिर सरणी 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')

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

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