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 ($a_id=0)
	Constructor. More...
	setId ($a_id)
	Set Id. More...
	getId ()
	Get Id. More...
	setContextObjId ($a_context_obj_id)
	Set ContextObjId. More...
	getContextObjId ()
	Get ContextObjId. More...
	setContextObjType ($a_context_obj_type)
	Set ContextObjType. More...
	getContextObjType ()
	Get ContextObjType. More...
	setContextSubObjId ($a_context_sub_obj_id)
	Set ContextSubObjId. More...
	getContextSubObjId ()
	Get ContextSubObjId. More...
	setContextSubObjType ($a_context_sub_obj_type)
	Set ContextSubObjType. More...
	getContextSubObjType ()
	Get ContextSubObjType. More...
	setType ($a_type)
	Set Type. More...
	getType ()
	Get Type. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	create ()
	Create new item. More...
	read ()
	Read item from database. More...
	update ()
	Update item in database. More...
	delete ()
	Delete item from database. More...
	querygetBlocksForContext ()
	Query getBlocksForContext. More...
	queryBlocksForContext ($a_include_sub_obj=true)
	Query BlocksForContext. More...
	queryTitleForId ()
	Query TitleForId. More...
	queryCntBlockForContext ()
	Query CntBlockForContext. More...

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

Protected Attributes
	$db
	$id
	$context_obj_id
	$context_obj_type
	$context_sub_obj_id
	$context_sub_obj_type
	$type
	$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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilCustomBlock::__construct

(

$a_id = 0

)

Constructor.

Parameters

int

$a_id

Reimplemented in ilExternalFeedBlock, and ilPollBlock.

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

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

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

Here is the call graph for this function:

Member Function Documentation

create()

ilCustomBlock::create

(

)

Create new item.

Reimplemented in ilExternalFeedBlock.

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

    {
        $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);
    }

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

Here is the call graph for this function:

delete()

ilCustomBlock::delete

(

)

Delete item from database.

Reimplemented in ilExternalFeedBlock.

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

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

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

Here is the call graph for this function:

getContextObjId()

ilCustomBlock::getContextObjId

(

)

Get ContextObjId.

Returns

int

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

    {
        return (int) $this->context_obj_id;
    }

References $context_obj_id.

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

Here is the caller graph for this function:

getContextObjType()

ilCustomBlock::getContextObjType

(

)

Get ContextObjType.

Returns

int

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

    {
        return $this->context_obj_type;
    }

References $context_obj_type.

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

Here is the caller graph for this function:

getContextSubObjId()

ilCustomBlock::getContextSubObjId

(

)

Get ContextSubObjId.

Returns

int

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

    {
        return (int) $this->context_sub_obj_id;
    }

References $context_sub_obj_id.

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

Here is the caller graph for this function:

getContextSubObjType()

ilCustomBlock::getContextSubObjType

(

)

Get ContextSubObjType.

Returns

int

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

    {
        return $this->context_sub_obj_type;
    }

References $context_sub_obj_type.

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

Here is the caller graph for this function:

getId()

ilCustomBlock::getId

(

)

Get Id.

Returns

int

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

    {
        return $this->id;
    }

References $id.

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

Here is the caller graph for this function:

getTitle()

ilCustomBlock::getTitle

(

)

Get Title.

Returns

string Title of block

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

    {
        return $this->title;
    }

References $title.

Referenced by create(), and update().

Here is the caller graph for this function:

getType()

ilCustomBlock::getType

(

)

Get Type.

Returns

string Type of block.

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

    {
        return $this->type;
    }

References $type.

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

Here is the caller graph for this function:

multiBlockQuery()

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

static

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

    {
        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, "", "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;
    }

References $DIC, $ilDB, $query, and $result.

queryBlocksForContext()

ilCustomBlock::queryBlocksForContext

(

$a_include_sub_obj = true

)

Query BlocksForContext.

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

    {
        $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_id) {
            $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;
    }

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

Here is the call graph for this function:

queryCntBlockForContext()

ilCustomBlock::queryCntBlockForContext

(

)

Query CntBlockForContext.

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

    {
        $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;
    }

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

Here is the call graph for this function:

querygetBlocksForContext()

ilCustomBlock::querygetBlocksForContext

(

)

Query getBlocksForContext.

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

    {
        $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") .
                " 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")."";
 
        $set = $ilDB->query($query);
        $result = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $result[] = $rec;
        }
        
        return $result;
    }

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

Here is the call graph for this function:

queryTitleForId()

ilCustomBlock::queryTitleForId

(

)

Query TitleForId.

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

    {
        $ilDB = $this->db;
        die("ilCustomBlock::queryTitleForId is deprecated");
        /*
                $query = "SELECT id ".
                    "FROM il_custom_block ".
                    "WHERE "."";
 
                $set = $ilDB->query($query);
                $result = array();
                while($rec = $set->fetchRow(ilDBConstants::FETCHMODE_ASSOC))
                {
                    $result[] = $rec;
                }
 
                return $result;
        */
    }

References $db, and $ilDB.

read()

ilCustomBlock::read

(

)

Read item from database.

Reimplemented in ilExternalFeedBlock.

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

    {
        $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($rec["context_obj_id"]);
        $this->setContextObjType($rec["context_obj_type"]);
        $this->setContextSubObjId($rec["context_sub_obj_id"]);
        $this->setContextSubObjType($rec["context_sub_obj_type"]);
        $this->setType($rec["type"]);
        $this->setTitle($rec["title"]);
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

setContextObjId()

ilCustomBlock::setContextObjId

(

$a_context_obj_id

)

Set ContextObjId.

Parameters

int

$a_context_obj_id

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

    {
        $this->context_obj_id = $a_context_obj_id;
    }

Referenced by read().

Here is the caller graph for this function:

setContextObjType()

ilCustomBlock::setContextObjType

(

$a_context_obj_type

)

Set ContextObjType.

Parameters

int

$a_context_obj_type

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

    {
        $this->context_obj_type = $a_context_obj_type;
    }

Referenced by read().

Here is the caller graph for this function:

setContextSubObjId()

ilCustomBlock::setContextSubObjId

(

$a_context_sub_obj_id

)

Set ContextSubObjId.

Parameters

int

$a_context_sub_obj_id

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

    {
        $this->context_sub_obj_id = $a_context_sub_obj_id;
    }

Referenced by read().

Here is the caller graph for this function:

setContextSubObjType()

ilCustomBlock::setContextSubObjType

(

$a_context_sub_obj_type

)

Set ContextSubObjType.

Parameters

int

$a_context_sub_obj_type

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

    {
        $this->context_sub_obj_type = $a_context_sub_obj_type;
    }

Referenced by read().

Here is the caller graph for this function:

setId()

ilCustomBlock::setId

(

$a_id

)

Set Id.

Parameters

int

$a_id

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

    {
        $this->id = $a_id;
    }

Referenced by ilExternalFeedBlock\__construct(), __construct(), and create().

Here is the caller graph for this function:

setTitle()

ilCustomBlock::setTitle

(

$a_title

)

Set Title.

Parameters

string

$a_title

Title of block

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

    {
        $this->title = $a_title;
    }

Referenced by read().

Here is the caller graph for this function:

setType()

ilCustomBlock::setType

(

$a_type

)

Set Type.

Parameters

string

$a_type

Type of block.

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

    {
        $this->type = $a_type;
    }

References $a_type.

Referenced by read().

Here is the caller graph for this function:

update()

ilCustomBlock::update

(

)

Update item in database.

Reimplemented in ilExternalFeedBlock.

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

    {
        $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);
    }

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

Here is the call graph for this function:

Field Documentation

$context_obj_id

ilCustomBlock::$context_obj_id

protected

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

Referenced by getContextObjId().

$context_obj_type

ilCustomBlock::$context_obj_type

protected

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

Referenced by getContextObjType().

$context_sub_obj_id

ilCustomBlock::$context_sub_obj_id

protected

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

Referenced by getContextSubObjId().

$context_sub_obj_type

ilCustomBlock::$context_sub_obj_type

protected

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

Referenced by getContextSubObjType().

$db

ilCustomBlock::$db

protected

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

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

$id

ilCustomBlock::$id

protected

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

Referenced by getId().

$title

ilCustomBlock::$title

protected

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

Referenced by getTitle().

$type

ilCustomBlock::$type

protected

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

Referenced by getType().

---

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

• Services/Block/classes/class.ilCustomBlock.php