ILIAS\components\ToDoExample\TodoRepository Class Reference

Collaboration diagram for ILIAS\components\ToDoExample\TodoRepository:

Public Member Functions
	__construct (ilDBInterface $db)
	getItemsOfUser (int $user_id)
	Get the items of a user. More...
	createItem (TodoItem $item)
	Create an item in the database The returned item has an automatically created id. More...
	updateItem (TodoItem $item)
	Update an item in the database. More...
	deleteItem (ToDoItem $item)

Protected Attributes
ilDBInterface	$db

Detailed Description

Definition at line 25 of file TodoRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\components\ToDoExample\TodoRepository::__construct

(

ilDBInterface

$db

)

Definition at line 29 of file TodoRepository.php.

References ILIAS\components\ToDoExample\TodoRepository\$db.

    {
        $this->db = $db;
    }

Member Function Documentation

createItem()

ILIAS\components\ToDoExample\TodoRepository::createItem

(

TodoItem

$item

)

Create an item in the database The returned item has an automatically created id.

Definition at line 62 of file TodoRepository.php.

References ILIAS\components\ToDoExample\TodoItem\getDeadline(), ILIAS\components\ToDoExample\TodoItem\getDescription(), ILIAS\components\ToDoExample\TodoItem\getTitle(), ILIAS\components\ToDoExample\TodoItem\getUserId(), and ILIAS\components\ToDoExample\TodoItem\widthTodoId().

                                              : TodoItem
    {
        $todo_id = $this->db->nextId('todo_items');

        $this->db->insert('todo_items', [
            'todo_id' => ['integer', $todo_id],
            'user_id' => ['integer', $item->getUserId()],
            'title' => ['text', $item->getTitle()],
            'description' => ['clob', $item->getDescription()],
            'deadline' => ['date', $item->getDeadline()]
        ]);

        return $item->widthTodoId($todo_id);
    }

Here is the call graph for this function:

deleteItem()

ILIAS\components\ToDoExample\TodoRepository::deleteItem

(

ToDoItem

$item

)

Definition at line 94 of file TodoRepository.php.

                                              : void
    {
        $query = "DELETE FROM todo_items WHERE todo_id = %s";

        $this->db->manipulateF($query, ['integer'], [$item->getTodoId()]);
    }

getItemsOfUser()

ILIAS\components\ToDoExample\TodoRepository::getItemsOfUser

(

int

$user_id

)

Get the items of a user.

Returns

ToDoItem[]

Definition at line 38 of file TodoRepository.php.

                                                : array
    {
        $items = [];

        $query = "SELECT * FROM todo_items WHERE user_id = %s";

        $result = $this->db->queryF($query, ['integer'], [$user_id]);

        while ($row = $this->db->fetchAssoc($result)) {
            $items[] = new TodoItem(
                $row['item_id'],
                $row['user_id'],
                $row['title'],
                $row['description'] ?? null,
                $row['deadline'] ?? null
            );
        }
        return $items;
    }

updateItem()

ILIAS\components\ToDoExample\TodoRepository::updateItem

(

TodoItem

$item

)

Update an item in the database.

Definition at line 80 of file TodoRepository.php.

References ILIAS\components\ToDoExample\TodoItem\getDeadline(), ILIAS\components\ToDoExample\TodoItem\getDescription(), ILIAS\components\ToDoExample\TodoItem\getTitle(), ILIAS\components\ToDoExample\TodoItem\getTodoId(), and ILIAS\components\ToDoExample\TodoItem\getUserId().

                                              : void
    {
        $this->db->update('todo_items', [
            'user_id' => ['integer', $item->getUserId()],
            'title' => ['text', $item->getTitle()],
            'description' => ['clob', $item->getDescription()],
            'deadline' => ['date', $item->getDeadline()]
        ], [
            'todo_id' => ['integer', $item->getTodoId()]
        ]);

    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ILIAS\components\ToDoExample\TodoRepository::$db

protected

Definition at line 27 of file TodoRepository.php.

Referenced by ILIAS\components\ToDoExample\TodoRepository\__construct().

---

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

• docs/development/devguide/tutorial/04-coding/TodoExample/src/TodoRepository.php