class ExecutePHP in Devel PHP 8

Defines a form that allows privileged users to execute arbitrary PHP code.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\devel_php\Form\ExecutePHP

Expanded class hierarchy of ExecutePHP

1 string reference to 'ExecutePHP'

devel_php.routing.yml in ./devel_php.routing.yml: devel_php.routing.yml

File

src/Form/ExecutePHP.php, line 14

Namespace

Drupal\devel_php\Form

View source

class ExecutePHP extends FormBase {

  /**
   * The devel dumper manager service.
   *
   * @var \Drupal\devel\DevelDumperManagerInterface
   */
  protected $develDumper;

  /**
   * The session service.
   *
   * @var \Symfony\Component\HttpFoundation\Session\SessionInterface
   */
  protected $session;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : self {
    $instance = parent::create($container);
    $instance->develDumper = $container
      ->get('devel.dumper');
    $instance->session = $container
      ->get('session');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'devel_execute_form';
  }

  /**
   * {@inheritdoc}
   *
   * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
   */
  public function buildForm(array $form, FormStateInterface $form_state, bool $details_open = TRUE) : array {
    $form['#redirect'] = FALSE;
    $code = $this->session
      ->get('devel_execute_code', '');
    $form['execute'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('PHP code to execute'),
      '#open' => !empty($code) || $details_open,
    ];
    $form['execute']['code'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('PHP code to execute'),
      '#title_display' => 'invisible',
      '#description' => $this
        ->t('Enter some code. Do not use <code>&lt;?php ?&gt;</code> tags.'),
      '#default_value' => $code,
      '#rows' => 20,
      '#attributes' => [
        'style' => 'font-family: monospace; font-size: 1.25em;',
      ],
    ];
    $form['execute']['op'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Execute'),
    ];
    if ($this->session
      ->has('devel_execute_code')) {
      $this->session
        ->remove('devel_execute_code');
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   *
   * @SuppressWarnings(PHPMD.EvalExpression)
   */
  public function submitForm(array &$form, FormStateInterface $form_state) : void {
    $code = $form_state
      ->getValue('code');
    try {
      ob_start();

      // phpcs:ignore
      print eval($code);

      // phpcs:enable
      $this->develDumper
        ->message(ob_get_clean());
    } catch (\Throwable $error) {
      $this
        ->messenger()
        ->addError($error
        ->getMessage());
    }
    $this->session
      ->set('devel_execute_code', $code);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
ExecutePHP::$develDumper	protected	property	The devel dumper manager service.
ExecutePHP::$session	protected	property	The session service.
ExecutePHP::buildForm	public	function	Plugin annotation @SuppressWarnings(PHPMD . BooleanArgumentFlag); Overrides FormInterface::buildForm
ExecutePHP::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ExecutePHP::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ExecutePHP::submitForm	public	function	Plugin annotation @SuppressWarnings(PHPMD . EvalExpression); Overrides FormInterface::submitForm
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class ExecutePHP in Devel PHP 8

Hierarchy

File

Namespace

Members

API Navigation