ilCustomBlock Class Reference

This is the super class of all custom blocks. More...

Inheritance diagram for ilCustomBlock:

Collaboration diagram for ilCustomBlock:

Public Member Functions
	__construct (int $a_id=0)
	setId (int $a_id)
	getId ()
	setContextObjId (int $a_context_obj_id)
	getContextObjId ()
	setContextObjType (string $a_context_obj_type)
	getContextObjType ()
	setContextSubObjId (int $a_context_sub_obj_id)
	getContextSubObjId ()
	setContextSubObjType (string $a_context_sub_obj_type)
	getContextSubObjType ()
	setType (string $a_type)
	getType ()
	setTitle (string $a_title)
	getTitle ()
	create ()
	read ()
	update ()
	delete ()
	queryBlocksForContext (bool $a_include_sub_obj=true)
	Query BlocksForContext. More...
	queryCntBlockForContext ()

Static Public Member Functions
static	multiBlockQuery (string $a_context_obj_type, array $a_context_obj_ids)

Protected Attributes
ilDBInterface	$db
int	$id = 0
int	$context_obj_id = 0
string	$context_obj_type = ""
int	$context_sub_obj_id = 0
string	$context_sub_obj_type = ""
string	$type = ""
string	$title = ""

Detailed Description

This is the super class of all custom blocks.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilCustomBlock.php.

Constructor & Destructor Documentation

__construct()

ilCustomBlock::__construct

(

int

$a_id = 0

)

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

References $DIC, read(), and setId().

      {
        global $DIC;

        $this->db = $DIC->database();
        if ($a_id > 0) {
            $this->setId($a_id);
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilCustomBlock::create

(

)

Definition at line 121 of file class.ilCustomBlock.php.

References $db, $ilDB, getContextObjId(), getContextObjType(), getContextSubObjId(), getContextSubObjType(), getId(), getTitle(), getType(), and setId().

                            : void
    {
        $ilDB = $this->db;

        $this->setId($ilDB->nextId("il_custom_block"));
        $query = "INSERT INTO il_custom_block (" .
            " id" .
            ", context_obj_id" .
            ", context_obj_type" .
            ", context_sub_obj_id" .
            ", context_sub_obj_type" .
            ", type" .
            ", title" .
            " ) VALUES (" .
            $ilDB->quote($this->getId(), "integer")
            . "," . $ilDB->quote($this->getContextObjId(), "integer")
            . "," . $ilDB->quote($this->getContextObjType(), "text")
            . "," . $ilDB->quote($this->getContextSubObjId(), "integer")
            . "," . $ilDB->quote($this->getContextSubObjType(), "text")
            . "," . $ilDB->quote($this->getType(), "text")
            . "," . $ilDB->quote($this->getTitle(), "text") . ")";
        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

delete()

ilCustomBlock::delete

(

)

Definition at line 178 of file class.ilCustomBlock.php.

References $db, $ilDB, and getId().

                            : void
    {
        $ilDB = $this->db;

        $query = "DELETE FROM il_custom_block" .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer");

        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

getContextObjId()

ilCustomBlock::getContextObjId

(

)

Definition at line 63 of file class.ilCustomBlock.php.

References $context_obj_id.

Referenced by create(), queryBlocksForContext(), queryCntBlockForContext(), and update().

                                     : int
    {
        return $this->context_obj_id;
    }

Here is the caller graph for this function:

getContextObjType()

ilCustomBlock::getContextObjType

(

)

Definition at line 73 of file class.ilCustomBlock.php.

References $context_obj_type.

Referenced by create(), queryBlocksForContext(), queryCntBlockForContext(), and update().

                                       : string
    {
        return $this->context_obj_type;
    }

Here is the caller graph for this function:

getContextSubObjId()

ilCustomBlock::getContextSubObjId

(

)

Definition at line 83 of file class.ilCustomBlock.php.

References $context_sub_obj_id.

Referenced by create(), queryBlocksForContext(), queryCntBlockForContext(), and update().

                                        : int
    {
        return $this->context_sub_obj_id;
    }

Here is the caller graph for this function:

getContextSubObjType()

ilCustomBlock::getContextSubObjType

(

)

Definition at line 93 of file class.ilCustomBlock.php.

References $context_sub_obj_type.

Referenced by create(), queryBlocksForContext(), queryCntBlockForContext(), and update().

                                          : string
    {
        return $this->context_sub_obj_type;
    }

Here is the caller graph for this function:

getId()

ilCustomBlock::getId

(

)

Definition at line 53 of file class.ilCustomBlock.php.

References $id.

Referenced by create(), delete(), read(), ilPollBlockGUI\setBlock(), and update().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getTitle()

ilCustomBlock::getTitle

(

)

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

References $title.

Referenced by create(), and update().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

ilCustomBlock::getType

(

)

Definition at line 106 of file class.ilCustomBlock.php.

References $type.

Referenced by create(), queryCntBlockForContext(), and update().

                             : string
    {
        return $this->type;
    }

Here is the caller graph for this function:

multiBlockQuery()

static ilCustomBlock::multiBlockQuery ( string  $a_context_obj_type, array  $a_context_obj_ids  )

static

Definition at line 238 of file class.ilCustomBlock.php.

References $DIC, and $ilDB.

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT id, context_obj_id, context_obj_type, context_sub_obj_id, context_sub_obj_type, type, title " .
            "FROM il_custom_block " .
            "WHERE " .
                $ilDB->in("context_obj_id", $a_context_obj_ids, false, "integer") .
                " AND context_obj_type = " . $ilDB->quote($a_context_obj_type, "text") .
            " ORDER BY title";
        $set = $ilDB->query($query);
        $result = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $result[] = $rec;
        }

        return $result;
    }

queryBlocksForContext()

ilCustomBlock::queryBlocksForContext

(

bool

$a_include_sub_obj = true

)

Query BlocksForContext.

Definition at line 191 of file class.ilCustomBlock.php.

References $db, $ilDB, getContextObjId(), getContextObjType(), getContextSubObjId(), and getContextSubObjType().

     : array {
        $ilDB = $this->db;

        $query = "SELECT id, context_obj_id, context_obj_type, context_sub_obj_id, context_sub_obj_type, type, title " .
            "FROM il_custom_block " .
            "WHERE " .
                "context_obj_id = " . $ilDB->quote($this->getContextObjId(), "integer") .
                " AND context_obj_type = " . $ilDB->quote($this->getContextObjType(), "text");
        if ($a_include_sub_obj) {
            $query .= " AND context_sub_obj_id = " . $ilDB->quote($this->getContextSubObjId(), "integer") .
                " AND " . $ilDB->equals("context_sub_obj_type", $this->getContextSubObjType(), "text", true);
            //" AND context_sub_obj_type = ".$ilDB->quote($this->getContextSubObjType(), "text")."";
        }
        //echo "$query";
        $set = $ilDB->query($query);
        $result = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $result[] = $rec;
        }

        return $result;
    }

Here is the call graph for this function:

queryCntBlockForContext()

ilCustomBlock::queryCntBlockForContext

(

)

Definition at line 216 of file class.ilCustomBlock.php.

References $db, $ilDB, getContextObjId(), getContextObjType(), getContextSubObjId(), getContextSubObjType(), and getType().

                                             : array
    {
        $ilDB = $this->db;

        $query = "SELECT count(*) as cnt " .
            "FROM il_custom_block " .
            "WHERE " .
                "context_obj_id = " . $ilDB->quote($this->getContextObjId(), "integer") .
                " AND context_obj_type = " . $ilDB->quote($this->getContextObjType(), "text") .
                " AND context_sub_obj_id = " . $ilDB->quote($this->getContextSubObjId(), "integer") .
                " AND " . $ilDB->equals("context_sub_obj_type", $this->getContextSubObjType(), "text", true) .
                " AND type = " . $ilDB->quote($this->getType(), "text");

        $set = $ilDB->query($query);
        $result = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $result[] = $rec;
        }

        return $result;
    }

Here is the call graph for this function:

read()

ilCustomBlock::read

(

)

Definition at line 145 of file class.ilCustomBlock.php.

References $db, $ilDB, getId(), setContextObjId(), setContextObjType(), setContextSubObjId(), setContextSubObjType(), setTitle(), and setType().

Referenced by __construct().

                          : void
    {
        $ilDB = $this->db;

        $query = "SELECT * FROM il_custom_block WHERE id = " .
            $ilDB->quote($this->getId(), "integer");
        $set = $ilDB->query($query);
        $rec = $ilDB->fetchAssoc($set);

        $this->setContextObjId((int) $rec["context_obj_id"]);
        $this->setContextObjType($rec["context_obj_type"]);
        $this->setContextSubObjId((int) $rec["context_sub_obj_id"]);
        $this->setContextSubObjType((string) $rec["context_sub_obj_type"]);
        $this->setType($rec["type"]);
        $this->setTitle((string) $rec["title"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContextObjId()

ilCustomBlock::setContextObjId

(

int

$a_context_obj_id

)

Definition at line 58 of file class.ilCustomBlock.php.

Referenced by read().

                                                          : void
    {
        $this->context_obj_id = $a_context_obj_id;
    }

Here is the caller graph for this function:

setContextObjType()

ilCustomBlock::setContextObjType

(

string

$a_context_obj_type

)

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

Referenced by read().

                                                                 : void
    {
        $this->context_obj_type = $a_context_obj_type;
    }

Here is the caller graph for this function:

setContextSubObjId()

ilCustomBlock::setContextSubObjId

(

int

$a_context_sub_obj_id

)

Definition at line 78 of file class.ilCustomBlock.php.

Referenced by read().

                                                                 : void
    {
        $this->context_sub_obj_id = $a_context_sub_obj_id;
    }

Here is the caller graph for this function:

setContextSubObjType()

ilCustomBlock::setContextSubObjType

(

string

$a_context_sub_obj_type

)

Definition at line 88 of file class.ilCustomBlock.php.

Referenced by read().

                                                                        : void
    {
        $this->context_sub_obj_type = $a_context_sub_obj_type;
    }

Here is the caller graph for this function:

setId()

ilCustomBlock::setId

(

int

$a_id

)

Definition at line 48 of file class.ilCustomBlock.php.

Referenced by __construct(), and create().

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

Here is the caller graph for this function:

setTitle()

ilCustomBlock::setTitle

(

string

$a_title

)

Definition at line 111 of file class.ilCustomBlock.php.

Referenced by read(), and PollBlockTest\testSetTitle().

                                             : void
    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setType()

ilCustomBlock::setType

(

string

$a_type

)

Parameters

string

$a_type

Type of block.

Definition at line 101 of file class.ilCustomBlock.php.

Referenced by read().

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

Here is the caller graph for this function:

update()

ilCustomBlock::update

(

)

Definition at line 162 of file class.ilCustomBlock.php.

References $db, $ilDB, getContextObjId(), getContextObjType(), getContextSubObjId(), getContextSubObjType(), getId(), getTitle(), and getType().

                            : void
    {
        $ilDB = $this->db;

        $query = "UPDATE il_custom_block SET " .
            " context_obj_id = " . $ilDB->quote($this->getContextObjId(), "integer") .
            ", context_obj_type = " . $ilDB->quote($this->getContextObjType(), "text") .
            ", context_sub_obj_id = " . $ilDB->quote($this->getContextSubObjId(), "integer") .
            ", context_sub_obj_type = " . $ilDB->quote($this->getContextSubObjType(), "text") .
            ", type = " . $ilDB->quote($this->getType(), "text") .
            ", title = " . $ilDB->quote($this->getTitle(), "text") .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer");

        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

Field Documentation

$context_obj_id

int ilCustomBlock::$context_obj_id = 0

protected

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

Referenced by getContextObjId().

$context_obj_type

string ilCustomBlock::$context_obj_type = ""

protected

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

Referenced by getContextObjType().

$context_sub_obj_id

int ilCustomBlock::$context_sub_obj_id = 0

protected

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

Referenced by getContextSubObjId().

$context_sub_obj_type

string ilCustomBlock::$context_sub_obj_type = ""

protected

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

Referenced by getContextSubObjType().

$db

ilDBInterface ilCustomBlock::$db

protected

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

Referenced by create(), delete(), queryBlocksForContext(), queryCntBlockForContext(), read(), and update().

$id

int ilCustomBlock::$id = 0

protected

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

Referenced by getId().

$title

string ilCustomBlock::$title = ""

protected

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

Referenced by getTitle().

$type

string ilCustomBlock::$type = ""

protected

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

Referenced by getType().

---

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

• components/ILIAS/Block/classes/class.ilCustomBlock.php