Skip to content

Commit

Permalink
4011 debug container (#4012)
Browse files Browse the repository at this point in the history 
* Add new arguments key and target. Make it possible use not only default target for db connections

* Fix output warnings, fix style of the code, refactoring, add methods' documentation
  • Loading branch information
@LOBsTerr
LOBsTerr authored Apr 5, 2019
1 parent 1a7ba53 commit dafe9ea
Showing 1 changed file with 140 additions and 35 deletions.
175 changes: 140 additions & 35 deletions src/Command/Debug/ContainerCommand.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@
*/
class ContainerCommand extends ContainerAwareCommand
{

const BLUE = 'blue';
const CYAN = 'cyan';
const GREEN = 'green';
const MAGENTA = 'magenta';
const RED = 'red';
const YELLOW = 'yellow';
const WHITE = 'white';

/**
* {@inheritdoc}
*/
Expand Down Expand Up @@ -101,12 +110,25 @@ protected function execute(InputInterface $input, OutputInterface $output)
return 0;
}

/**
* Get callback list.
*
* @param string $service
* Service name.
* @param string $method
* Methods name.
* @param array $args
* Arguments.
*
* @return array
* List of callbacks.
*/
private function getCallbackReturnList($service, $method, $args)
{
if ($args != null) {
$parsedArgs = json_decode($args, true);
if (!is_array($parsedArgs)) {
$parsedArgs = explode(",", $args);
$parsedArgs = explode(',', $args);
}
} else {
$parsedArgs = null;
Expand All @@ -119,34 +141,43 @@ private function getCallbackReturnList($service, $method, $args)
return $serviceDetail;
}
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.service').'</>',
'<fg=yellow>'.$service.'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.service'),
$this->addWrapper($service),
];
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.class').'</>',
'<fg=yellow>'.get_class($serviceInstance).'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.class'),
$this->addWrapper(get_class($serviceInstance)),
];
$methods = [$method];
$this->extendArgumentList($serviceInstance, $methods);
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.method').'</>',
'<fg=yellow>'.$methods[0].'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.method'),
$this->addWrapper($methods[0]),
];
if ($parsedArgs) {
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.arguments').'</>',
json_encode($parsedArgs, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)
$this->addGreenTranslationWrapper('commands.debug.container.messages.arguments'),
$this->addWrapper(json_encode($parsedArgs, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)),
];
}
$return = call_user_func_array([$serviceInstance,$method], $parsedArgs);
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.return').'</>',
json_encode($return, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)
$this->addGreenTranslationWrapper('commands.debug.container.messages.return'),
$this->addWrapper(json_encode($return, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)),
];
return $serviceDetail;
}

private function getServiceList($tag)
/**
* Get service list.
*
* @param string $tag
* Tag.
*
* @return array
* Array of services.
*/
private function getServiceList($tag = null)
{
if ($tag) {
return $this->getServiceListByTag($tag);
Expand All @@ -162,6 +193,15 @@ private function getServiceList($tag)
return $services;
}

/**
* Get service list by a tag.
*
* @param string $tag
* Tag.
*
* @return array
* Array of services.
*/
private function getServiceListByTag($tag)
{
$services = [];
Expand All @@ -186,6 +226,17 @@ private function getServiceListByTag($tag)
return $services;
}

/**
* Compares the values.
*
* @param string $a
* First value.
* @param string $b
* Second value.
*
* @return int
* Result.
*/
private function compareService($a, $b)
{
return strcmp($a[0], $b[0]);
Expand All @@ -195,41 +246,42 @@ private function getServiceDetail($service)
{
$serviceInstance = $this->get($service);
$serviceDetail = [];
$class_name = get_class($serviceInstance);

if ($serviceInstance) {
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.service').'</>',
'<fg=yellow>'.$service.'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.service'),
$this->addTranslationWrapper('commands.debug.container.messages.service'),
];
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.class').'</>',
'<fg=yellow>'.get_class($serviceInstance).'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.class'),
$this->addTranslationWrapper('commands.debug.container.messages.class'),
];
$interface = str_replace("{ }", "", Yaml::dump(class_implements($serviceInstance)));
$interface = str_replace('{ }', '', Yaml::dump(class_implements($serviceInstance)));
if (!empty($interface)) {
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.interface').'</>',
'<fg=yellow>'.$interface.'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.interface'),
$this->addWrapper($interface),
];
}
if ($parent = get_parent_class($serviceInstance)) {
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.parent').'</>',
'<fg=yellow>'.$parent.'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.parent'),
$this->addWrapper($parent),
];
}
if ($vars = get_class_vars($serviceInstance)) {
if ($vars = get_class_vars($class_name)) {
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.variables').'</>',
'<fg=yellow>'.Yaml::dump($vars).'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.variables'),
$this->addWrapper(Yaml::dump($vars)),
];
}
if ($methods = get_class_methods($serviceInstance)) {
if ($methods = get_class_methods($class_name)) {
sort($methods);
$this->extendArgumentList($serviceInstance, $methods);
$serviceDetail[] = [
'<fg=green>'.$this->trans('commands.debug.container.messages.methods').'</>',
'<fg=yellow>'.implode("\n", $methods).'</>'
$this->addGreenTranslationWrapper('commands.debug.container.messages.methods'),
$this->addWrapper(implode("\n", $methods)),
];
}
} else {
Expand All @@ -240,6 +292,50 @@ private function getServiceDetail($service)

return $serviceDetail;
}

/**
* Adds a wrapper with a color
*
* @param string $text
* Text.
* @param string $color
* Color.
*
* @return string
* Result of the wrapping.
*/
private function addWrapper($text, $color = ContainerCommand::YELLOW)
{
return "<fg=$color>$text</>";
}

/**
* Adds green color wrapper.
*
* @param string $translationString
* Translation string.
*
* @return string
* Result of the wrapping.
*/
private function addGreenTranslationWrapper($translationString)
{
return $this->addTranslationWrapper($translationString, ContainerCommand::GREEN);
}

/**
* Adds green color wrapper.
*
* @param string $translationString
* Translation string.
*
* @return string
* Result of the wrapping.
*/
private function addTranslationWrapper($translationString, $color = ContainerCommand::YELLOW) {
return $this->addWrapper($this->trans($translationString), $color);
}

private function extendArgumentList($serviceInstance, &$methods)
{
foreach ($methods as $k => $m) {
Expand All @@ -248,37 +344,48 @@ private function extendArgumentList($serviceInstance, &$methods)
$p = [];

for ($i = 0; $i < count($params); $i++) {

if ($params[$i]->isDefaultValueAvailable()) {
$defaultVar = $params[$i]->getDefaultValue();
$defaultVar = " = <fg=magenta>".str_replace(["\n","array ("], ["", "array("], var_export($def, true)).'</>';
$defaultVar = ' = ' . $this->addWrapper(str_replace(["\n",'array ('], ['', 'array('], var_export($defaultVar, true)), ContainerCommand::MAGENTA);
} else {
$defaultVar = '';
}

if (method_exists($params[$i], 'hasType') && method_exists($params[$i], 'getType')) {
if ($params[$i]->hasType()) {
$defaultType = '<fg=white>'.strval($params[$i]->getType()).'</> ';
$defaultType = $this->addWrapper( strval($params[$i]->getType()), ContainerCommand::WHITE) . ' ';
} else {
$defaultType = '';
}
} else {
$defaultType = '';
}

if ($params[$i]->isPassedByReference()) {
$parameterReference = '<fg=yellow>&</>';
$parameterReference = $this->addWrapper('&');
} else {
$parameterReference = '';
}
$p[] = $defaultType.$parameterReference.'<fg=red>'.'$</><fg=red>'.$params[$i]->getName().'</>'.$defaultVar;

$p[] = $defaultType . $parameterReference . $this->addWrapper('$' . $params[$i]->getName(), ContainerCommand::RED) . $defaultVar;
}

if ($reflection->isPublic()) {
$methods[$k] = '<fg=cyan>'.$methods[$k]."</><fg=blue>(</>".implode(', ', $p)."<fg=blue>) </> ";
$methods[$k] = $this->addWrapper($methods[$k], ContainerCommand::CYAN) . $this->addWrapper('(', ContainerCommand::BLUE) . implode(', ', $p) . $this->addWrapper(')', ContainerCommand::BLUE);
}
}
}

/**
* Get parameter list.
*
* @return array
* Array with parameter.
*/
private function getParameterList()
{
$parameters = array_filter(
return array_filter(
$this->container->getParameterBag()->all(), function ($name) {
if (preg_match('/^container\./', $name)) {
return false;
Expand All @@ -292,7 +399,5 @@ private function getParameterList()
return true;
}, ARRAY_FILTER_USE_KEY
);

return $parameters;
}
}

0 comments on commit dafe9ea

Please sign in to comment.