FM / Command

/home/techb158/ileadtechnology.com/SSM/vendor/psy/psysh/src/Command/

/home/techb158/ileadtechnology.com/SSM/vendor/psy/psysh/src/Command

Name	Size	Mode	Actions
ListCommand/	-	0755	rm
TimeitCommand/	-	0755	rm
BufferCommand.php	2218	0644	edit dl rm
ClearCommand.php	1059	0644	edit dl rm
Command.php	7958	0644	edit dl rm
DocCommand.php	4356	0644	edit dl rm
DumpCommand.php	2540	0644	edit dl rm
EditCommand.php	5709	0644	edit dl rm
ExitCommand.php	1084	0644	edit dl rm
HelpCommand.php	2944	0644	edit dl rm
HistoryCommand.php	7650	0644	edit dl rm
ListCommand.php	10121	0644	edit dl rm
ParseCommand.php	5027	0644	edit dl rm
PsyVersionCommand.php	953	0644	edit dl rm
ReflectingCommand.php	10578	0644	edit dl rm
ShowCommand.php	9518	0644	edit dl rm
SudoCommand.php	3772	0644	edit dl rm
ThrowUpCommand.php	4504	0644	edit dl rm
TimeitCommand.php	5353	0644	edit dl rm
TraceCommand.php	5154	0644	edit dl rm
WhereamiCommand.php	4326	0644	edit dl rm
WtfCommand.php	3791	0644	edit dl rm

Edit: /home/techb158/ileadtechnology.com/SSM/vendor/psy/psysh/src/Command/DocCommand.php (4356B)

<?php

/*
 * This file is part of Psy Shell.
 *
 * (c) 2012-2020 Justin Hileman
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Psy\Command;

use Psy\Formatter\DocblockFormatter;
use Psy\Formatter\SignatureFormatter;
use Psy\Input\CodeArgument;
use Psy\Reflection\ReflectionClassConstant;
use Psy\Reflection\ReflectionConstant_;
use Psy\Reflection\ReflectionLanguageConstruct;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Read the documentation for an object, class, constant, method or property.
 */
class DocCommand extends ReflectingCommand
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('doc')
            ->setAliases(['rtfm', 'man'])
            ->setDefinition([
                new CodeArgument('target', CodeArgument::REQUIRED, 'Function, class, instance, constant, method or property to document.'),
            ])
            ->setDescription('Read the documentation for an object, class, constant, method or property.')
            ->setHelp(
                <<<HELP
Read the documentation for an object, class, constant, method or property.

It's awesome for well-documented code, not quite as awesome for poorly documented code.

e.g.
<return>>>> doc preg_replace</return>
<return>>>> doc Psy\Shell</return>
<return>>>> doc Psy\Shell::debug</return>
<return>>>> \$s = new Psy\Shell</return>
<return>>>> doc \$s->run</return>
HELP
            );
    }

/**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $value = $input->getArgument('target');
        if (ReflectionLanguageConstruct::isLanguageConstruct($value)) {
            $reflector = new ReflectionLanguageConstruct($value);
            $doc = $this->getManualDocById($value);
        } else {
            list($target, $reflector) = $this->getTargetAndReflector($value);
            $doc = $this->getManualDoc($reflector) ?: DocblockFormatter::format($reflector);
        }

$db = $this->getApplication()->getManualDb();

$output->page(function ($output) use ($reflector, $doc, $db) {
            $output->writeln(SignatureFormatter::format($reflector));
            $output->writeln('');

if (empty($doc) && !$db) {
                $output->writeln('<warning>PHP manual not found</warning>');
                $output->writeln('    To document core PHP functionality, download the PHP reference manual:');
                $output->writeln('    https://github.com/bobthecow/psysh/wiki/PHP-manual');
            } else {
                $output->writeln($doc);
            }
        });

// Set some magic local variables
        $this->setCommandScopeVariables($reflector);

return 0;
    }

private function getManualDoc($reflector)
    {
        switch (\get_class($reflector)) {
            case \ReflectionClass::class:
            case \ReflectionObject::class:
            case \ReflectionFunction::class:
                $id = $reflector->name;
                break;

case \ReflectionMethod::class:
                $id = $reflector->class . '::' . $reflector->name;
                break;

case \ReflectionProperty::class:
                $id = $reflector->class . '::$' . $reflector->name;
                break;

case \ReflectionClassConstant::class:
            case ReflectionClassConstant::class:
                // @todo this is going to collide with ReflectionMethod ids
                // someday... start running the query by id + type if the DB
                // supports it.
                $id = $reflector->class . '::' . $reflector->name;
                break;

case ReflectionConstant_::class:
                $id = $reflector->name;
                break;

default:
                return false;
        }

return $this->getManualDocById($id);
    }

private function getManualDocById($id)
    {
        if ($db = $this->getApplication()->getManualDb()) {
            return $db
                ->query(\sprintf('SELECT doc FROM php_manual WHERE id = %s', $db->quote($id)))
                ->fetchColumn(0);
        }
    }
}

setName('doc') ->setAliases(['rtfm', 'man']) ->setDefinition([ new CodeArgument('target', CodeArgument::REQUIRED, 'Function, class, instance, constant, method or property to document.'), ]) ->setDescription('Read the documentation for an object, class, constant, method or property.') ->setHelp( <<>>> doc preg_replace >>> doc Psy\Shell >>> doc Psy\Shell::debug >>> \$s = new Psy\Shell >>> doc \$s->run HELP ); } /** * {@inheritdoc} */ protected function execute(InputInterface $input, OutputInterface $output) { $value = $input->getArgument('target'); if (ReflectionLanguageConstruct::isLanguageConstruct($value)) { $reflector = new ReflectionLanguageConstruct($value); $doc = $this->getManualDocById($value); } else { list($target, $reflector) = $this->getTargetAndReflector($value); $doc = $this->getManualDoc($reflector) ?: DocblockFormatter::format($reflector); } $db = $this->getApplication()->getManualDb(); $output->page(function ($output) use ($reflector, $doc, $db) { $output->writeln(SignatureFormatter::format($reflector)); $output->writeln(''); if (empty($doc) && !$db) { $output->writeln('PHP manual not found'); $output->writeln(' To document core PHP functionality, download the PHP reference manual:'); $output->writeln(' https://github.com/bobthecow/psysh/wiki/PHP-manual'); } else { $output->writeln($doc); } }); // Set some magic local variables $this->setCommandScopeVariables($reflector); return 0; } private function getManualDoc($reflector) { switch (\get_class($reflector)) { case \ReflectionClass::class: case \ReflectionObject::class: case \ReflectionFunction::class: $id = $reflector->name; break; case \ReflectionMethod::class: $id = $reflector->class . '::' . $reflector->name; break; case \ReflectionProperty::class: $id = $reflector->class . '::$' . $reflector->name; break; case \ReflectionClassConstant::class: case ReflectionClassConstant::class: // @todo this is going to collide with ReflectionMethod ids // someday... start running the query by id + type if the DB // supports it. $id = $reflector->class . '::' . $reflector->name; break; case ReflectionConstant_::class: $id = $reflector->name; break; default: return false; } return $this->getManualDocById($id); } private function getManualDocById($id) { if ($db = $this->getApplication()->getManualDb()) { return $db ->query(\sprintf('SELECT doc FROM php_manual WHERE id = %s', $db->quote($id))) ->fetchColumn(0); } } }