- md5
- 62d9385b1735a149f8375c9b9ad278b1
- sha1
- 8a2e8238c14f56382fcb3e50b8458562df973001
- sha256
- dec776811c1bd85059d24cf24b73cc1d67a73402fbec7c07eff28e2dcc77f40e
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2018 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Console;
defined('JPATH_PLATFORM') or die;
use Joomla\Console\AbstractCommand;
use Joomla\DI\ContainerAwareInterface;
use Joomla\DI\ContainerAwareTrait;
use Joomla\Session\SessionInterface;
use Symfony\Component\Console\Input\InputOption;
/**
* Console command for performing session garbage collection
*
* @since 4.0.0
*/
class SessionGcCommand extends AbstractCommand implements ContainerAwareInterface
{
use ContainerAwareTrait;
/**
* Execute the command.
*
* @return integer The exit code for the command.
*
* @since 4.0.0
*/
public function execute(): int
{
$symfonyStyle = $this->createSymfonyStyle();
$symfonyStyle->title('Running Session Garbage Collection');
$session = $this->getSessionService($this->getApplication()->getConsoleInput()->getOption('application'));
$gcResult = $session->gc();
// Destroy the session started for this process
$session->destroy();
if ($gcResult === false)
{
$symfonyStyle->error('Garbage collection was not completed. Either the operation failed or is not supported on your platform.');
return 1;
}
$symfonyStyle->success('Garbage collection completed.');
return 0;
}
/**
* Initialise the command.
*
* @return void
*
* @since 4.0.0
*/
protected function initialise()
{
$this->setName('session:gc');
$this->setDescription('Performs session garbage collection');
$this->addOption('application', 'app', InputOption::VALUE_OPTIONAL, 'The application to perform garbage collection for.', 'site');
$this->setHelp(
<<<EOF
The <info>%command.name%</info> command runs PHP's garbage collection operation for session data
<info>php %command.full_name%</info>
This command defaults to performing garbage collection for the frontend (site) application. To run garbage collection
for another application, you can specify it with the <info>--application</info> option.
<info>php %command.full_name% --application=[APPLICATION]</info>
EOF
);
}
/**
* Get the session service for the requested application.
*
* @param string $application The application session service to retrieve
*
* @return SessionInterface
*
* @since 4.0.0
*/
private function getSessionService(string $application): SessionInterface
{
if (!$this->getContainer()->has("session.web.$application"))
{
throw new \InvalidArgumentException(
sprintf(
'The `%s` application is not a valid option.',
$application
)
);
}
return $this->getContainer()->get("session.web.$application");
}
}
The same content is in 2 releases, Joomla 4.0.0-alpha5 to 4.0.0-alpha6. See them all, or every version of this file.