ilLucenePathFilter Class Reference

Lucene path filter. More...

Inheritance diagram for ilLucenePathFilter:

Collaboration diagram for ilLucenePathFilter:

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

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

Protected Attributes
	$root = ROOT_FOLDER_ID
	$subnodes = array()

Detailed Description

Lucene path filter.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilLucenePathFilter::__construct

(

$a_root

)

Constructor.

Parameters

int

$a_root

root id

Returns

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

    {
        $this->root = $a_root;
        //$this->init();
    }

Member Function Documentation

filter()

ilLucenePathFilter::filter

(

$a_ref_id

)

Return whether a object reference is valid or not.

Parameters

int

$a_ref_id

reference id of object in question

Returns

boolean

Implements ilLuceneResultFilter.

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

References $DIC, and ROOT_FOLDER_ID.

    {
        global $DIC;

        $tree = $DIC['tree'];
        
        if ($this->root == ROOT_FOLDER_ID) {
            return true;
        }
        if ($this->root == $a_ref_id) {
            return true;
        }
        return $tree->isGrandChild($this->root, $a_ref_id);
    }

init()

ilLucenePathFilter::init ( )

protected

Read valid reference ids.

Returns

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

References $DIC, and ROOT_FOLDER_ID.

    {
        global $DIC;

        $tree = $DIC['tree'];
        
        if ($this->root == ROOT_FOLDER_ID) {
            $this->subnodes = array();
        } else {
            $node = $tree->getNodeData($this->root);
            $this->subnodes = $tree->getSubTree($node, false);
        }
    }

Field Documentation

$root

ilLucenePathFilter::$root = ROOT_FOLDER_ID

protected

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

$subnodes

ilLucenePathFilter::$subnodes = array()

protected

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

---

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

• Services/Search/classes/Lucene/class.ilLucenePathFilter.php