ilSearchCommandQueueElement Class Reference

Represents an entry for the search command queue. More...

Collaboration diagram for ilSearchCommandQueueElement:

Public Member Functions
	setObjId (int $a_id)
	set obj_id More...
	getObjId ()
	get obj_id More...
	setObjType (string $a_type)
	set obj_type More...
	getObjType ()
	get obj_type More...
	setCommand (string $a_command)
	set command More...
	getCommand ()
	get command More...
	setLastUpdate (ilDateTime $date_time)
	set last_update More...
	getLastUpdate ()
	get last update More...
	setFinished (bool $a_finished)
	set finsihed More...
	getFinished ()
	get finished More...

Data Fields
const	UPDATE = 'update'
const	DELETE = 'delete'
const	CREATE = 'create'
const	RESET = 'reset'

Private Attributes
int	$obj_id
string	$obj_type
string	$command
ilDateTime	$last_update
bool	$finished

Detailed Description

Represents an entry for the search command queue.

Author

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

@ingroupServicesSearch

Definition at line 28 of file class.ilSearchCommandQueueElement.php.

Member Function Documentation

getCommand()

ilSearchCommandQueueElement::getCommand

(

)

get command

Definition at line 84 of file class.ilSearchCommandQueueElement.php.

                                : string
    {
        return $this->command;
    }

References $command.

Referenced by ilSearchCommandQueue\store().

Here is the caller graph for this function:

getFinished()

ilSearchCommandQueueElement::getFinished

(

)

get finished

Definition at line 116 of file class.ilSearchCommandQueueElement.php.

                                 : bool
    {
        return $this->finished;
    }

References $finished.

getLastUpdate()

ilSearchCommandQueueElement::getLastUpdate

(

)

get last update

Definition at line 100 of file class.ilSearchCommandQueueElement.php.

                                   : ?ilDateTime
    {
        return is_object($this->last_update) ? $this->last_update : null;
    }

getObjId()

ilSearchCommandQueueElement::getObjId

(

)

get obj_id

Definition at line 52 of file class.ilSearchCommandQueueElement.php.

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

Referenced by ilSearchCommandQueue\store().

Here is the caller graph for this function:

getObjType()

ilSearchCommandQueueElement::getObjType

(

)

get obj_type

Definition at line 68 of file class.ilSearchCommandQueueElement.php.

                                : string
    {
        return $this->obj_type;
    }

References $obj_type.

Referenced by ilSearchCommandQueue\store().

Here is the caller graph for this function:

setCommand()

ilSearchCommandQueueElement::setCommand

(

string

$a_command

)

set command

Definition at line 76 of file class.ilSearchCommandQueueElement.php.

                                                 : void
    {
        $this->command = $a_command;
    }

setFinished()

ilSearchCommandQueueElement::setFinished

(

bool

$a_finished

)

set finsihed

Definition at line 108 of file class.ilSearchCommandQueueElement.php.

                                                 : void
    {
        $this->finished = $a_finished;
    }

setLastUpdate()

ilSearchCommandQueueElement::setLastUpdate

(

ilDateTime

$date_time

)

set last_update

Definition at line 92 of file class.ilSearchCommandQueueElement.php.

                                                        : void
    {
        $this->last_update = $date_time;
    }

setObjId()

ilSearchCommandQueueElement::setObjId

(

int

$a_id

)

set obj_id

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

                                       : void
    {
        $this->obj_id = $a_id;
    }

setObjType()

ilSearchCommandQueueElement::setObjType

(

string

$a_type

)

set obj_type

Definition at line 60 of file class.ilSearchCommandQueueElement.php.

                                              : void
    {
        $this->obj_type = $a_type;
    }

Field Documentation

$command

string ilSearchCommandQueueElement::$command

private

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

Referenced by getCommand().

$finished

bool ilSearchCommandQueueElement::$finished

private

Definition at line 39 of file class.ilSearchCommandQueueElement.php.

Referenced by getFinished().

$last_update

ilDateTime ilSearchCommandQueueElement::$last_update

private

Definition at line 38 of file class.ilSearchCommandQueueElement.php.

$obj_id

int ilSearchCommandQueueElement::$obj_id

private

Definition at line 35 of file class.ilSearchCommandQueueElement.php.

Referenced by getObjId().

$obj_type

string ilSearchCommandQueueElement::$obj_type

private

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

Referenced by getObjType().

CREATE

const ilSearchCommandQueueElement::CREATE = 'create'

Definition at line 32 of file class.ilSearchCommandQueueElement.php.

Referenced by ilSearchAppEventListener\handleEvent().

DELETE

const ilSearchCommandQueueElement::DELETE = 'delete'

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

Referenced by ilSearchAppEventListener\handleEvent().

RESET

const ilSearchCommandQueueElement::RESET = 'reset'

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

Referenced by ilSearchAppEventListener\handleEvent().

UPDATE

const ilSearchCommandQueueElement::UPDATE = 'update'

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

---

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

• components/ILIAS/Search/classes/class.ilSearchCommandQueueElement.php