RemoveOrphanedThreadedComments.php

Go to the documentation of this file.

<?php

namespace Elgg\Upgrades;

use Elgg\Database\EntityTable;
use Elgg\Database\QueryBuilder;
use Elgg\Upgrade\AsynchronousUpgrade;
use Elgg\Upgrade\Result;

class RemoveOrphanedThreadedComments extends AsynchronousUpgrade {
    
    public function getVersion(): int {
        return 2023011701;
    }
    
    public function shouldBeSkipped(): bool {
        return empty($this->countItems());
    }
    
    public function needsIncrementOffset(): bool {
        return false;
    }
    
    public function countItems(): int {
        return elgg_count_entities($this->getOptions());
    }
    
    public function run(Result $result, $offset): Result {
        /* @var $batch \ElggBatch */
        $batch = elgg_get_entities($this->getOptions([
            'offset' => $offset,
        ]));
        /* @var $comment \ElggComment */
        foreach ($batch as $comment) {
            if ($comment->delete()) {
                $result->addSuccesses();
                continue;
            }
            
            $result->addFailures();
        }
        
        return $result;
    }
    
    protected function getOptions(array $options = []): array {
        $defaults = [
            'type' => 'object',
            'subtype' => 'comment',
            'limit' => 100,
            'batch' => true,
            'batch_inc_offset' => $this->needsIncrementOffset(),
            'batch_size' => 50,
            'metadata_name_value_pairs' => [
                'name' => 'parent_guid',
                'value' => 0,
                'operand' => '>'
            ],
            'wheres' => [
                function (QueryBuilder $qb, $main_alias) {
                    $sub = $qb->subquery(EntityTable::TABLE_NAME);
                    $sub->select('guid')
                        ->where($qb->compare('type', '=', 'object', ELGG_VALUE_STRING))
                        ->andWhere($qb->compare('subtype', '=', 'comment', ELGG_VALUE_STRING));
                    
                    $md = $qb->joinMetadataTable($main_alias, 'guid', 'parent_guid');
                    return $qb->compare("{$md}.value", 'NOT IN', $sub->getSQL());
                }
            ],
        ];
        
        return array_merge($defaults, $options);
    }
}