ElggComment.php

Go to the documentation of this file.

<?php
class ElggComment extends \ElggObject {
    
    protected function initializeAttributes() {
        parent::initializeAttributes();

        $this->attributes['subtype'] = 'comment';
        
        $this->level = 1;
    }
    
    protected function persistentDelete(bool $recursive = true): bool {
        $result = parent::persistentDelete($recursive);
        
        if ($result) {
            $this->deleteThreadedComments($recursive, true);
        }
        
        return $result;
    }
    
    protected function trash(bool $recursive = true): bool {
        $result = parent::trash($recursive);
        
        if ($result) {
            $this->deleteThreadedComments($recursive, false);
        }
        
        return $result;
    }
    
    public function restore(bool $recursive = true): bool {
        $result = parent::restore($recursive);
        
        if ($result) {
            // restore threaded comments
            elgg_call(ELGG_IGNORE_ACCESS | ELGG_SHOW_DISABLED_ENTITIES | ELGG_SHOW_DELETED_ENTITIES, function() use ($recursive) {
                /* @var $children \ElggBatch */
                $children = elgg_get_entities([
                    'type' => 'object',
                    'subtype' => 'comment',
                    'limit' => false,
                    'batch' => true,
                    'metadata_name_value_pairs' => [
                        'name' => 'parent_guid',
                        'value' => $this->guid,
                    ],
                ]);
                
                /* @var $child \ElggComment */
                foreach ($children as $child) {
                    $child->restore($recursive);
                }
            });
        }
        
        return $result;
    }
    
    protected function deleteThreadedComments(bool $recursive, bool $persistent): void {
        elgg_call(ELGG_IGNORE_ACCESS | ELGG_SHOW_DISABLED_ENTITIES | ELGG_SHOW_DELETED_ENTITIES, function() use ($recursive, $persistent) {
            /* @var $children \ElggBatch */
            $children = elgg_get_entities([
                'type' => 'object',
                'subtype' => 'comment',
                'limit' => false,
                'batch' => true,
                'batch_inc_offset' => !$persistent,
                'metadata_name_value_pairs' => [
                    'name' => 'parent_guid',
                    'value' => $this->guid,
                ],
            ]);
            
            /* @var $child \ElggComment */
            foreach ($children as $child) {
                if (!$child->delete($recursive, $persistent) && $persistent) {
                    $children->reportFailure();
                }
            }
        });
    }
    
    public function canComment(int $user_guid = 0): bool {
        if ($this->getLevel() >= (int) elgg_get_config('comments_max_depth')) {
            return false;
        }
        
        $container = $this->getContainerEntity();
        if (!$container instanceof ElggEntity) {
            return false;
        }
        
        return $container->canComment($user_guid);
    }
    
    public function isCreatedByContentOwner(): bool {
        return elgg_call(ELGG_IGNORE_ACCESS, function() {
            $container = $this->getContainerEntity();
            if (!$container instanceof ElggEntity) {
                return false;
            }
            
            return $container->owner_guid === $this->owner_guid;
        });
    }
    
    public function getLevel(): int {
        return isset($this->level) ? (int) $this->level : 1;
    }
    
    public function getThreadGUID(): int {
        if (isset($this->thread_guid)) {
            return (int) $this->thread_guid;
        }
        
        return $this->guid;
    }
    
    public function getThreadEntity(): ?\ElggComment {
        $entity = get_entity($this->getThreadGUID());
        return $entity instanceof \ElggComment ? $entity : null;
    }
}