Symfony 4.1

Command




symfony

Command

क्लास कमांड

सभी कमांड के लिए बेस क्लास।

गुण

स्थैतिक संरक्षित स्ट्रिंग | अशक्त | $ defaultName

तरीके

स्थिर स्ट्रिंग | अशक्त getDefaultName ()
__construct (स्ट्रिंग $ नाम = अशक्त)
ignoreValidationErrors

सत्यापन त्रुटियों को अनदेखा करता है।

setApplication ( Application $ आवेदन = अशक्त)
setHelperSet ( HelperSet $ हेल्परसेट)
HelperSet getHelperSet ()

सहायक सेट हो जाता है।

Application getApplication ()

इस कमांड के लिए एप्लिकेशन इंस्टेंस प्राप्त करता है।

bool isEnabled ()

जाँचता है कि कमांड चालू परिवेश में सक्षम है या नहीं।

configure ()

वर्तमान कमांड को कॉन्फ़िगर करता है।

पूर्णांक | अशक्त execute ( InputInterface $ इनपुट, OutputInterface $ आउटपुट)

वर्तमान आदेश निष्पादित करता है।

interact ( InputInterface $ इनपुट, OutputInterface $ आउटपुट)

उपयोगकर्ता के साथ बातचीत करता है।

initialize ( InputInterface $ इनपुट, OutputInterface $ आउटपुट)

इनपुट बाध्य होने के बाद और इनपुट मान्य होने से पहले कमांड को प्रारंभ करता है।

पूर्णांक run ( InputInterface $ इनपुट, OutputInterface $ आउटपुट)

कमांड चलाता है।

इस $ setCode ( setCode योग्य $ कोड)

इस कमांड को चलाते समय कोड को सेट करें।

mergeApplicationDefinition (bool $ mergeArgs = true)

कमांड की परिभाषा के साथ आवेदन की परिभाषा को जोड़ता है।

इस $ setDefinition (सरणी | InputDefinition $ परिभाषा)

तर्क और विकल्प उदाहरणों की एक सरणी सेट करता है।

InputDefinition getDefinition ()

इस कमांड से जुड़ा इनपुटडिफ़िनिशन हो जाता है।

InputDefinition getNativeDefinition ()

इस कमांड के अभ्यावेदन बनाने के लिए InputDefinition का उपयोग किया जाता है।

इस $ addArgument (स्ट्रिंग $ नाम, int | null $ mode = null, string $ description = '', string & string []] null $ default = null)

एक तर्क जोड़ता है।

इस $ addOption (string $ name, string | array $ शॉर्टकट = null, int। null $ mode = null, string $ description = '', string | string [] | बूल | null $ default = null)

एक विकल्प जोड़ता है।

इस $ setName (स्ट्रिंग $ नाम)

कमांड का नाम सेट करता है।

इस $ setProcessTitle (स्ट्रिंग $ शीर्षक)

कमांड का प्रोसेस टाइटल सेट करता है।

तार getName ()

कमांड नाम लौटाता है।

Command setHidden (बूल $ छिपा हुआ)
bool isHidden ()
इस $ setDescription (स्ट्रिंग $ विवरण)

कमांड के लिए विवरण सेट करता है।

तार getDescription ()

कमांड के लिए विवरण लौटाता है।

इस $ setHelp (स्ट्रिंग $ सहायता)

आदेश के लिए मदद सेट करता है।

तार getHelp ()

आदेश के लिए मदद लौटाता है।

तार getProcessedHelp ()

कमांड के लिए संसाधित सहायता लौटाता है, जो वास्तविक रूप से वास्तविक मानों के साथ% कमांड.नाम% और% कमांड.फुल_नाम% पैटर्न की जगह लेता है।

इस $ setAliases (स्ट्रिंग [] $ एलियास)

आदेश के लिए उपनाम सेट करता है।

सरणी getAliases ()

आज्ञा के लिए उपनाम देता है।

तार getSynopsis (बूल $ शॉर्ट = गलत)

आदेश के लिए सिनोप्सिस लौटाता है।

इस $ addUsage (स्ट्रिंग $ उपयोग)

एक कमांड उपयोग उदाहरण जोड़ें।

सरणी getUsages ()

कमांड का वैकल्पिक उपयोग करता है।

मिश्रित getHelper (स्ट्रिंग $ नाम)

नाम से एक सहायक उदाहरण मिलता है।

विवरण

स्थिर स्ट्रिंग | अशक्त getDefaultName ()

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

स्ट्रिंग | अशक्त डिफ़ॉल्ट कमांड नाम या शून्य जब कोई डिफ़ॉल्ट नाम सेट नहीं होता है

__construct (स्ट्रिंग $ नाम = अशक्त)

पैरामीटर

तार $ नाम आज्ञा का नाम; null पास होने का मतलब है इसे कॉन्फ़िगर में सेट किया जाना चाहिए ()

अपवाद

LogicException जब कमांड नाम खाली हो

ignoreValidationErrors ()

सत्यापन त्रुटियों को अनदेखा करता है।

यह मुख्य रूप से हेल्प कमांड के लिए उपयोगी है।

setApplication ( Application $ आवेदन = अशक्त)

पैरामीटर

Application $ आवेदन

सेट हेल्परसेट ( HelperSet $ हेल्परसेट)

पैरामीटर

HelperSet $ helperSet

HelperSet getHelperSet ()

सहायक सेट हो जाता है।

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

HelperSet एक हेल्परसेट उदाहरण

Application getApplication ()

इस कमांड के लिए एप्लिकेशन इंस्टेंस प्राप्त करता है।

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

Application एक अनुप्रयोग उदाहरण

बूल अक्षम है ()

जाँचता है कि कमांड चालू परिवेश में सक्षम है या नहीं।

एक्स या वाई की जांच करने के लिए इसे ओवरराइड करें और यदि वर्तमान परिस्थितियों में ठीक से नहीं चल सकता है तो गलत लौटाएं।

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

bool

संरक्षित कॉन्फ़िगर ()

वर्तमान कमांड को कॉन्फ़िगर करता है।

संरक्षित int | null execute ( InputInterface $ input, OutputInterface $ आउटपुट)

वर्तमान आदेश निष्पादित करता है।

यह विधि अमूर्त नहीं है क्योंकि आप इस वर्ग को एक ठोस वर्ग के रूप में उपयोग कर सकते हैं। इस स्थिति में, निष्पादित () विधि को परिभाषित करने के बजाय, आप कोड को सेटकोड () विधि से बंद करके निष्पादित करने के लिए सेट करते हैं।

पैरामीटर

InputInterface $ इनपुट
OutputInterface $ उत्पादन

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

पूर्णांक | अशक्त अशक्त या 0 यदि सब कुछ ठीक हो गया, या एक त्रुटि कोड

अपवाद

LogicException जब इस अमूर्त विधि को लागू नहीं किया जाता है

यह भी देखें

setCode ()

संरक्षित इंटरैक्शन ( InputInterface $ इनपुट, OutputInterface $ आउटपुट)

उपयोगकर्ता के साथ बातचीत करता है।

InputDefinition के मान्य होने से पहले इस विधि को निष्पादित किया जाता है। इसका मतलब है कि यह एकमात्र स्थान है जहां कमांड लापता आवश्यक तर्कों के मूल्यों के लिए पारस्परिक रूप से पूछ सकता है।

पैरामीटर

InputInterface $ इनपुट
OutputInterface $ उत्पादन

संरक्षित इनिशियलाइज़ ( InputInterface $ इनपुट, OutputInterface $ आउटपुट)

इनपुट बाध्य होने के बाद और इनपुट मान्य होने से पहले कमांड को प्रारंभ करता है।

यह मुख्य रूप से तब उपयोगी होता है जब बहुत सारी कमांड एक मुख्य कमांड का विस्तार करती है जहां इनपुट तर्कों और विकल्पों के आधार पर कुछ चीजों को आरंभीकृत करने की आवश्यकता होती है।

पैरामीटर

InputInterface $ इनपुट
OutputInterface $ उत्पादन

यह भी देखें

InputInterface::bind
InputInterface::validate

int रन ( InputInterface $ इनपुट, OutputInterface $ आउटपुट)

कमांड चलाता है।

निष्पादित करने के लिए कोड या तो सीधे सेटकोड () विधि के साथ या उप-वर्ग में निष्पादित () विधि को ओवरराइड करके परिभाषित किया गया है।

पैरामीटर

InputInterface $ इनपुट
OutputInterface $ उत्पादन

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

पूर्णांक कमांड एग्जिट कोड

अपवाद

Exception जब बाध्यकारी इनपुट विफल हो जाता है। इसे {@link ignValidationErrors ()} पर कॉल करके बायपास करें।

यह भी देखें

setCode ()
निष्पादित()

$ यह सेटकोड (कॉल करने योग्य $ कोड)

इस कमांड को चलाते समय कोड को सेट करें।

यदि इस पद्धति का उपयोग किया जाता है, तो यह निष्पादित () विधि में परिभाषित कोड को ओवरराइड करता है।

पैरामीटर

प्रतिदेय $ कोड एक कॉल करने योग्य (इनपुटइंटरफेस $ इनपुट, आउटपुटइंटरफेस $ आउटपुट)

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

इस $

अपवाद

InvalidArgumentException

यह भी देखें

निष्पादित()

mergeApplicationDefinition (bool $ mergeArgs = true)

कमांड की परिभाषा के साथ आवेदन की परिभाषा को जोड़ता है।

यह विधि सार्वजनिक API का हिस्सा नहीं है और इसे सीधे उपयोग नहीं किया जाना चाहिए।

पैरामीटर

bool $ mergeArgs कमांड परिभाषा तर्कों के लिए एप्लिकेशन परिभाषा तर्कों को मर्ज करना है या नहीं

$ यह सेटडिफ़िनेशन (सरणी | InputDefinition $ परिभाषा)

तर्क और विकल्प उदाहरणों की एक सरणी सेट करता है।

पैरामीटर

सरणी | InputDefinition $ परिभाषा तर्क और विकल्प उदाहरण या परिभाषा उदाहरण की एक सरणी

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

इस $

InputDefinition getDefinition ()

इस कमांड से जुड़ा इनपुटडिफ़िनिशन हो जाता है।

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

InputDefinition एक InputDefinition उदाहरण

InputDefinition getNativeDefinition ()

इस कमांड के अभ्यावेदन बनाने के लिए InputDefinition का उपयोग किया जाता है।

मूल कमांड प्रतिनिधित्व प्रदान करने के लिए ओवरराइड किया जा सकता है जब इसे अन्यथा इनपुट इनपुटफाइनेशन के साथ विलय करके बदल दिया जाएगा।

यह विधि सार्वजनिक API का हिस्सा नहीं है और इसे सीधे उपयोग नहीं किया जाना चाहिए।

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

InputDefinition एक InputDefinition उदाहरण

इस जोड़ को जोड़ दें (स्ट्रिंग $ नाम, int | null $ mode = null, string $ description = '', string | string [] | null $ default = null)

एक तर्क जोड़ता है।

पैरामीटर

तार $ नाम तर्क नाम
पूर्णांक | अशक्त $ मोड तर्क मोड: स्वयं :: आवश्यक या स्व :: वैकल्पिक
तार $ विवरण एक विवरण पाठ
स्ट्रिंग | स्ट्रिंग [] | अशक्त $ डिफ़ॉल्ट डिफ़ॉल्ट मान (स्वयं के लिए: वैकल्पिक मोड केवल)

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

इस $

अपवाद

InvalidArgumentException जब तर्क मोड मान्य नहीं है

$ इस AddOption (स्ट्रिंग $ नाम, स्ट्रिंग | सरणी $ शॉर्टकट = अशक्त, int | अशक्त $ मोड = अशक्त, स्ट्रिंग $ विवरण = '', स्ट्रिंग | स्ट्रिंग [] | बूल | शून्य $ डिफ़ॉल्ट = अशक्त)

एक विकल्प जोड़ता है।

पैरामीटर

तार $ नाम विकल्प का नाम
स्ट्रिंग | सरणी $ शॉर्टकट शॉर्टकट, अशक्त हो सकता है, शॉर्टकट के एक स्ट्रिंग द्वारा सीमांकित | या शॉर्टकट की एक सरणी
पूर्णांक | अशक्त $ मोड विकल्प मोड: VALUE_ * स्थिरांक में से एक
तार $ विवरण एक विवरण पाठ
स्ट्रिंग | स्ट्रिंग [] | bool | अशक्त $ डिफ़ॉल्ट डिफ़ॉल्ट मान (स्वयं के लिए रिक्त होना चाहिए :: VALUE_NONE)

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

इस $

अपवाद

InvalidArgumentException यदि विकल्प मोड अमान्य या असंगत है

$ यह सेटनाम (स्ट्रिंग $ नाम)

कमांड का नाम सेट करता है।

यह विधि नाम और नाम दोनों को सेट कर सकती है यदि आप उन्हें एक बृहदान्त्र द्वारा अलग करते हैं (:)

$command->setName('foo:bar');

पैरामीटर

तार $ नाम आज्ञा नाम

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

इस $

अपवाद

InvalidArgumentException जब नाम अमान्य है

$ यह सेटप्रोसेसटाइल (स्ट्रिंग $ शीर्षक)

कमांड का प्रोसेस टाइटल सेट करता है।

डेमन की तरह लंबी प्रक्रिया कमांड बनाते समय इस सुविधा का उपयोग किया जाना चाहिए।

PHP 5.5+ या प्रॉक्टिटेल PECL लाइब्रेरी की आवश्यकता है

पैरामीटर

तार $ शीर्षक प्रक्रिया शीर्षक

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

इस $

स्ट्रिंग गेटनेम ()

कमांड नाम लौटाता है।

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

तार आज्ञा नाम

Command सेट किया गया (बूल $ छिपा हुआ)

पैरामीटर

bool $ छिपा हुआ कमांड की सूची से कमांड को छिपाया जाना चाहिए या नहीं

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

Command वर्तमान उदाहरण

बूल

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

bool आदेश सार्वजनिक रूप से दिखाया जाना चाहिए या नहीं

$ यह सेटडेसक्रिप्शन (स्ट्रिंग $ विवरण)

कमांड के लिए विवरण सेट करता है।

पैरामीटर

तार $ विवरण कमांड के लिए विवरण

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

इस $

स्ट्रिंग getDescription ()

कमांड के लिए विवरण लौटाता है।

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

तार कमांड के लिए विवरण

$ यह सेटहेल्प (स्ट्रिंग $ सहायता)

आदेश के लिए मदद सेट करता है।

पैरामीटर

तार $ मदद आदेश के लिए मदद

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

इस $

स्ट्रिंग गेट हेल्प ()

आदेश के लिए मदद लौटाता है।

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

तार आदेश के लिए मदद

स्ट्रिंग getProcessedHelp ()

कमांड के लिए संसाधित सहायता लौटाता है, जो वास्तविक रूप से वास्तविक मानों के साथ% कमांड.नाम% और% कमांड.फुल_नाम% पैटर्न की जगह लेता है।

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

तार आदेश के लिए संसाधित मदद

$ इस सेटएलाइसेस (स्ट्रिंग [] $ एलियास)

आदेश के लिए उपनाम सेट करता है।

पैरामीटर

स्ट्रिंग [] $ उपनाम कमान के लिए उपनाम की एक सरणी

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

इस $

अपवाद

InvalidArgumentException जब कोई अन्य व्यक्ति अमान्य है

सरणी getAliases ()

आज्ञा के लिए उपनाम देता है।

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

सरणी कमान के लिए उपनाम की एक सरणी

स्ट्रिंग getSynopsis (बूल $ शॉर्ट = गलत)

आदेश के लिए सिनोप्सिस लौटाता है।

पैरामीटर

bool $ कम सारांश के संक्षिप्त संस्करण को दिखाना है (मुड़े हुए विकल्पों के साथ) या नहीं

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

तार सिनॉप्सिस

$ इस addUsage (स्ट्रिंग $ उपयोग)

एक कमांड उपयोग उदाहरण जोड़ें।

पैरामीटर

तार $ उपयोग उपयोग, इसे कमांड नाम के साथ उपसर्ग किया जाएगा

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

इस $

सरणी गेटअप ()

कमांड का वैकल्पिक उपयोग करता है।

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

सरणी

मिश्रित गेट हेल्पर (स्ट्रिंग $ नाम)

नाम से एक सहायक उदाहरण मिलता है।

पैरामीटर

तार $ नाम सहायक नाम

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

मिश्रित सहायक मूल्य

अपवाद

LogicException यदि कोई हेल्परसेट परिभाषित नहीं है
InvalidArgumentException यदि सहायक को परिभाषित नहीं किया गया है