100 lines
3.7 KiB
PHP
100 lines
3.7 KiB
PHP
<?php
|
|
/*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* This software consists of voluntary contributions made by many individuals
|
|
* and is licensed under the LGPL. For more information, see
|
|
* <http://www.doctrine-project.org>.
|
|
*/
|
|
|
|
namespace Doctrine\ORM\Tools\Console\Command\ClearCache;
|
|
|
|
use Symfony\Component\Console\Input\InputArgument,
|
|
Symfony\Component\Console\Input\InputOption,
|
|
Symfony\Component\Console;
|
|
|
|
/**
|
|
* Command to clear the query cache of the various cache drivers.
|
|
*
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
* @link www.doctrine-project.org
|
|
* @since 2.0
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
|
|
* @author Jonathan Wage <jonwage@gmail.com>
|
|
* @author Roman Borschel <roman@code-factory.org>
|
|
*/
|
|
class QueryCommand extends Console\Command\Command
|
|
{
|
|
/**
|
|
* @see Console\Command\Command
|
|
*/
|
|
protected function configure()
|
|
{
|
|
$this
|
|
->setName('orm:clear-cache:query')
|
|
->setDescription('Clear all query cache of the various cache drivers.')
|
|
->setDefinition(array(
|
|
new InputOption(
|
|
'flush', null, InputOption::VALUE_NONE,
|
|
'If defined, cache entries will be flushed instead of deleted/invalidated.'
|
|
)
|
|
));
|
|
|
|
$fullName = $this->getName();
|
|
$this->setHelp(<<<EOT
|
|
The <info>$fullName</info> command is meant to clear the query cache of associated Entity Manager.
|
|
It is possible to invalidate all cache entries at once - called delete -, or flushes the cache provider
|
|
instance completely.
|
|
|
|
The execution type differ on how you execute the command.
|
|
If you want to invalidate the entries (and not delete from cache instance), this command would do the work:
|
|
|
|
<info>$fullName</info>
|
|
|
|
Alternatively, if you want to flush the cache provider using this command:
|
|
|
|
<info>$fullName --flush</info>
|
|
|
|
Finally, be aware that if <info>--flush</info> option is passed, not all cache providers are able to flush entries,
|
|
because of a limitation of its execution nature.
|
|
EOT
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @see Console\Command\Command
|
|
*/
|
|
protected function execute(Console\Input\InputInterface $input, Console\Output\OutputInterface $output)
|
|
{
|
|
$em = $this->getHelper('em')->getEntityManager();
|
|
$cacheDriver = $em->getConfiguration()->getQueryCacheImpl();
|
|
|
|
if ( ! $cacheDriver) {
|
|
throw new \InvalidArgumentException('No Query cache driver is configured on given EntityManager.');
|
|
}
|
|
|
|
$output->write('Clearing ALL Query cache entries' . PHP_EOL);
|
|
|
|
$result = $cacheDriver->deleteAll();
|
|
$message = ($result) ? 'Successfully deleted cache entries.' : 'No cache entries were deleted.';
|
|
|
|
if (true === $input->getOption('flush')) {
|
|
$result = $cacheDriver->flushAll();
|
|
$message = ($result) ? 'Successfully flushed cache entries.' : $message;
|
|
}
|
|
|
|
$output->write($message . PHP_EOL);
|
|
}
|
|
}
|