Verzeichnisstruktur phpBB-3.3.15
- Veröffentlicht
- 28.08.2024
So funktioniert es
|
|
Auf das letzte Element klicken. Dies geht jeweils ein Schritt zurück |
Auf das Icon klicken, dies öffnet das Verzeichnis. Nochmal klicken schließt das Verzeichnis. |
|
|
(Beispiel Datei-Icons)
|
Auf das Icon klicken um den Quellcode anzuzeigen |
XmlDescriptor.php
001 <?php
002
003 /*
004 * This file is part of the Symfony package.
005 *
006 * (c) Fabien Potencier <fabien@symfony.com>
007 *
008 * For the full copyright and license information, please view the LICENSE
009 * file that was distributed with this source code.
010 */
011
012 namespace Symfony\Component\Console\Descriptor;
013
014 use Symfony\Component\Console\Application;
015 use Symfony\Component\Console\Command\Command;
016 use Symfony\Component\Console\Input\InputArgument;
017 use Symfony\Component\Console\Input\InputDefinition;
018 use Symfony\Component\Console\Input\InputOption;
019
020 /**
021 * XML descriptor.
022 *
023 * @author Jean-François Simon <contact@jfsimon.fr>
024 *
025 * @internal
026 */
027 class XmlDescriptor extends Descriptor
028 {
029 /**
030 * @return \DOMDocument
031 */
032 public function getInputDefinitionDocument(InputDefinition $definition)
033 {
034 $dom = new \DOMDocument('1.0', 'UTF-8');
035 $dom->appendChild($definitionXML = $dom->createElement('definition'));
036
037 $definitionXML->appendChild($argumentsXML = $dom->createElement('arguments'));
038 foreach ($definition->getArguments() as $argument) {
039 $this->appendDocument($argumentsXML, $this->getInputArgumentDocument($argument));
040 }
041
042 $definitionXML->appendChild($optionsXML = $dom->createElement('options'));
043 foreach ($definition->getOptions() as $option) {
044 $this->appendDocument($optionsXML, $this->getInputOptionDocument($option));
045 }
046
047 return $dom;
048 }
049
050 /**
051 * @return \DOMDocument
052 */
053 public function getCommandDocument(Command $command)
054 {
055 $dom = new \DOMDocument('1.0', 'UTF-8');
056 $dom->appendChild($commandXML = $dom->createElement('command'));
057
058 $command->getSynopsis();
059 $command->mergeApplicationDefinition(false);
060
061 $commandXML->setAttribute('id', $command->getName());
062 $commandXML->setAttribute('name', $command->getName());
063 $commandXML->setAttribute('hidden', $command->isHidden() ? 1 : 0);
064
065 $commandXML->appendChild($usagesXML = $dom->createElement('usages'));
066
067 foreach (array_merge([$command->getSynopsis()], $command->getAliases(), $command->getUsages()) as $usage) {
068 $usagesXML->appendChild($dom->createElement('usage', $usage));
069 }
070
071 $commandXML->appendChild($descriptionXML = $dom->createElement('description'));
072 $descriptionXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $command->getDescription())));
073
074 $commandXML->appendChild($helpXML = $dom->createElement('help'));
075 $helpXML->appendChild($dom->createTextNode(str_replace("\n", "\n ", $command->getProcessedHelp())));
076
077 $definitionXML = $this->getInputDefinitionDocument($command->getNativeDefinition());
078 $this->appendDocument($commandXML, $definitionXML->getElementsByTagName('definition')->item(0));
079
080 return $dom;
081 }
082
083 /**
084 * @param string|null $namespace
085 *
086 * @return \DOMDocument
087 */
088 public function getApplicationDocument(Application $application, $namespace = null)
089 {
090 $dom = new \DOMDocument('1.0', 'UTF-8');
091 $dom->appendChild($rootXml = $dom->createElement('symfony'));
092
093 if ('UNKNOWN' !== $application->getName()) {
094 $rootXml->setAttribute('name', $application->getName());
095 if ('UNKNOWN' !== $application->getVersion()) {
096 $rootXml->setAttribute('version', $application->getVersion());
097 }
098 }
099
100 $rootXml->appendChild($commandsXML = $dom->createElement('commands'));
101
102 $description = new ApplicationDescription($application, $namespace, true);
103
104 if ($namespace) {
105 $commandsXML->setAttribute('namespace', $namespace);
106 }
107
108 foreach ($description->getCommands() as $command) {
109 $this->appendDocument($commandsXML, $this->getCommandDocument($command));
110 }
111
112 if (!$namespace) {
113 $rootXml->appendChild($namespacesXML = $dom->createElement('namespaces'));
114
115 foreach ($description->getNamespaces() as $namespaceDescription) {
116 $namespacesXML->appendChild($namespaceArrayXML = $dom->createElement('namespace'));
117 $namespaceArrayXML->setAttribute('id', $namespaceDescription['id']);
118
119 foreach ($namespaceDescription['commands'] as $name) {
120 $namespaceArrayXML->appendChild($commandXML = $dom->createElement('command'));
121 $commandXML->appendChild($dom->createTextNode($name));
122 }
123 }
124 }
125
126 return $dom;
127 }
128
129 /**
130 * {@inheritdoc}
131 */
132 protected function describeInputArgument(InputArgument $argument, array $options = [])
133 {
134 $this->writeDocument($this->getInputArgumentDocument($argument));
135 }
136
137 /**
138 * {@inheritdoc}
139 */
140 protected function describeInputOption(InputOption $option, array $options = [])
141 {
142 $this->writeDocument($this->getInputOptionDocument($option));
143 }
144
145 /**
146 * {@inheritdoc}
147 */
148 protected function describeInputDefinition(InputDefinition $definition, array $options = [])
149 {
150 $this->writeDocument($this->getInputDefinitionDocument($definition));
151 }
152
153 /**
154 * {@inheritdoc}
155 */
156 protected function describeCommand(Command $command, array $options = [])
157 {
158 $this->writeDocument($this->getCommandDocument($command));
159 }
160
161 /**
162 * {@inheritdoc}
163 */
164 protected function describeApplication(Application $application, array $options = [])
165 {
166 $this->writeDocument($this->getApplicationDocument($application, isset($options['namespace']) ? $options['namespace'] : null));
167 }
168
169 /**
170 * Appends document children to parent node.
171 */
172 private function appendDocument(\DOMNode $parentNode, \DOMNode $importedParent)
173 {
174 foreach ($importedParent->childNodes as $childNode) {
175 $parentNode->appendChild($parentNode->ownerDocument->importNode($childNode, true));
176 }
177 }
178
179 /**
180 * Writes DOM document.
181 */
182 private function writeDocument(\DOMDocument $dom)
183 {
184 $dom->formatOutput = true;
185 $this->write($dom->saveXML());
186 }
187
188 /**
189 * @return \DOMDocument
190 */
191 private function getInputArgumentDocument(InputArgument $argument)
192 {
193 $dom = new \DOMDocument('1.0', 'UTF-8');
194
195 $dom->appendChild($objectXML = $dom->createElement('argument'));
196 $objectXML->setAttribute('name', $argument->getName());
197 $objectXML->setAttribute('is_required', $argument->isRequired() ? 1 : 0);
198 $objectXML->setAttribute('is_array', $argument->isArray() ? 1 : 0);
199 $objectXML->appendChild($descriptionXML = $dom->createElement('description'));
200 $descriptionXML->appendChild($dom->createTextNode($argument->getDescription()));
201
202 $objectXML->appendChild($defaultsXML = $dom->createElement('defaults'));
203 $defaults = \is_array($argument->getDefault()) ? $argument->getDefault() : (\is_bool($argument->getDefault()) ? [var_export($argument->getDefault(), true)] : ($argument->getDefault() ? [$argument->getDefault()] : []));
204 foreach ($defaults as $default) {
205 $defaultsXML->appendChild($defaultXML = $dom->createElement('default'));
206 $defaultXML->appendChild($dom->createTextNode($default));
207 }
208
209 return $dom;
210 }
211
212 /**
213 * @return \DOMDocument
214 */
215 private function getInputOptionDocument(InputOption $option)
216 {
217 $dom = new \DOMDocument('1.0', 'UTF-8');
218
219 $dom->appendChild($objectXML = $dom->createElement('option'));
220 $objectXML->setAttribute('name', '--'.$option->getName());
221 $pos = strpos($option->getShortcut(), '|');
222 if (false !== $pos) {
223 $objectXML->setAttribute('shortcut', '-'.substr($option->getShortcut(), 0, $pos));
224 $objectXML->setAttribute('shortcuts', '-'.str_replace('|', '|-', $option->getShortcut()));
225 } else {
226 $objectXML->setAttribute('shortcut', $option->getShortcut() ? '-'.$option->getShortcut() : '');
227 }
228 $objectXML->setAttribute('accept_value', $option->acceptValue() ? 1 : 0);
229 $objectXML->setAttribute('is_value_required', $option->isValueRequired() ? 1 : 0);
230 $objectXML->setAttribute('is_multiple', $option->isArray() ? 1 : 0);
231 $objectXML->appendChild($descriptionXML = $dom->createElement('description'));
232 $descriptionXML->appendChild($dom->createTextNode($option->getDescription()));
233
234 if ($option->acceptValue()) {
235 $defaults = \is_array($option->getDefault()) ? $option->getDefault() : (\is_bool($option->getDefault()) ? [var_export($option->getDefault(), true)] : ($option->getDefault() ? [$option->getDefault()] : []));
236 $objectXML->appendChild($defaultsXML = $dom->createElement('defaults'));
237
238 if (!empty($defaults)) {
239 foreach ($defaults as $default) {
240 $defaultsXML->appendChild($defaultXML = $dom->createElement('default'));
241 $defaultXML->appendChild($dom->createTextNode($default));
242 }
243 }
244 }
245
246 return $dom;
247 }
248 }
249