ilLucenePathFilter Class Reference

Lucene path filter. More...

Inheritance diagram for ilLucenePathFilter:

Collaboration diagram for ilLucenePathFilter:

Public Member Functions
	__construct (int $a_root)
	filter (int $a_ref_id)
	Return whether a object reference is valid or not. More...

Protected Member Functions
	init ()
	Read valid reference ids. More...

Protected Attributes
int	$root
array	$subnodes = []
ilTree	$tree

Detailed Description

Lucene path filter.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 27 of file class.ilLucenePathFilter.php.

Constructor & Destructor Documentation

__construct()

ilLucenePathFilter::__construct

(

int

$a_root

)

Definition at line 33 of file class.ilLucenePathFilter.php.

References $DIC.

    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        $this->root = $a_root;
    }

Member Function Documentation

filter()

ilLucenePathFilter::filter

(

int

$a_ref_id

)

Return whether a object reference is valid or not.

Implements ilLuceneResultFilter.

Definition at line 44 of file class.ilLucenePathFilter.php.

References ROOT_FOLDER_ID.

                                         : bool
    {
        if ($this->root == ROOT_FOLDER_ID) {
            return true;
        }
        if ($this->root == $a_ref_id) {
            return true;
        }
        return $this->tree->isGrandChild($this->root, $a_ref_id);
    }

init()

ilLucenePathFilter::init ( )

protected

Read valid reference ids.

Returns

void

Definition at line 59 of file class.ilLucenePathFilter.php.

References ROOT_FOLDER_ID.

                             : void
    {
        if ($this->root == ROOT_FOLDER_ID) {
            $this->subnodes = array();
        } else {
            $node = $this->tree->getNodeData($this->root);
            $this->subnodes = $this->tree->getSubTree($node, false);
        }
    }

Field Documentation

$root

int ilLucenePathFilter::$root

protected

Definition at line 29 of file class.ilLucenePathFilter.php.

$subnodes

array ilLucenePathFilter::$subnodes = []

protected

Definition at line 30 of file class.ilLucenePathFilter.php.

$tree

ilTree ilLucenePathFilter::$tree

protected

Definition at line 31 of file class.ilLucenePathFilter.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Search/classes/Lucene/class.ilLucenePathFilter.php