PHP 클래스 Nag_Driver_Sql, horde

The table structure can be created by the scripts/sql/nag.sql script. See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
저자: Jon Parise ([email protected])
상속: extends Nag_Driver
파일 보기 프로젝트 열기: horde/horde

보호된 프로퍼티들

프로퍼티 타입 설명
$_db Horde_Db_Adapter Handle for the current database connection.

공개 메소드들

메소드 설명
__construct ( string $tasklist, array $params = [] ) Constructs a new SQL storage object.
get ( $taskIds ) : Nag_Task Retrieves one or multiple tasks from the database.
getByUID ( $uids, array $tasklists = null, boolean $getall = true ) : Nag_Task Retrieves one or multiple tasks from the database by UID.
getChildren ( string $parentId, boolean $include_history = true ) : array Retrieves sub-tasks from the database.
listAlarms ( integer $date ) : array Lists all alarms near $date.
retrieve ( integer $completed = Nag::VIEW_ALL, boolean $include_history = true ) Retrieves tasks from the database.

보호된 메소드들

메소드 설명
_add ( array $task ) : string Adds a task to the backend storage.
_addRecurrenceFields ( array &$values, array $task ) Adds recurrence information to the value hash for SQL INSERT/UPDATE queries.
_buildTask ( array $row, boolean $include_history = true ) : array Return an array describing this task from the provided backend data.
_delete ( string $taskId ) Deletes a task from the backend.
_deleteAll ( ) : array Deletes all tasks from the backend.
_getBy ( $taskIds, string $column, array $tasklists = null ) : Nag_Task Retrieves one or multiple tasks from the database.
_modify ( string $taskId, array $task ) Modifies an existing task.
_move ( string $taskId, string $newTasklist ) Moves a task to a different tasklist.

메소드 상세

__construct() 공개 메소드

Constructs a new SQL storage object.
public __construct ( string $tasklist, array $params = [] )
$tasklist string The tasklist to load.
$params array A hash containing connection parameters.

_add() 보호된 메소드

Adds a task to the backend storage.
protected _add ( array $task ) : string
$task array A hash with the following possible properties: - actual: (float) The actual time spent on the task. - alarm: (integer) The alarm associated with the task. - assignee: (string) The assignee of the event. - completed: (integer) The completion state of the task. - desc: (string) The description (long) of the task. - due: (integer) The due date of the task. - estimate: (float) The estimated time to complete the task. - methods: (array) The overridden alarm notification methods. - name: (string) The name (short) of the task. - organizer: (string) The organizer/owner of the task. - owner: (string) The owner of the event. - parent: (string) The parent task. - priority: (integer) The priority of the task. - private: (boolean) Whether the task is private. - recurrence: (Horde_Date_Recurrence|array) Recurrence information. - start: (integer) The start date of the task. - tags: (array) The task tags. - uid: (string) A Unique Identifier for the task.
리턴 string The Nag ID of the new task.

_addRecurrenceFields() 보호된 메소드

Adds recurrence information to the value hash for SQL INSERT/UPDATE queries.
protected _addRecurrenceFields ( array &$values, array $task )
$values array The fields to update.
$task array The task information.

_buildTask() 보호된 메소드

Return an array describing this task from the provided backend data.
protected _buildTask ( array $row, boolean $include_history = true ) : array
$row array The backend data
$include_history boolean Include history data.
리턴 array The task data.

_delete() 보호된 메소드

Deletes a task from the backend.
protected _delete ( string $taskId )
$taskId string The task to delete.

_deleteAll() 보호된 메소드

Deletes all tasks from the backend.
protected _deleteAll ( ) : array
리턴 array An array of uids that have been removed.

_getBy() 보호된 메소드

Retrieves one or multiple tasks from the database.
protected _getBy ( $taskIds, string $column, array $tasklists = null ) : Nag_Task
$column string The column name to search for the ID.
$tasklists array
리턴 Nag_Task A Nag_Task object.

_modify() 보호된 메소드

Modifies an existing task.
protected _modify ( string $taskId, array $task )
$taskId string The task to modify.
$task array

_move() 보호된 메소드

Moves a task to a different tasklist.
protected _move ( string $taskId, string $newTasklist )
$taskId string The task to move.
$newTasklist string The new tasklist.

get() 공개 메소드

Retrieves one or multiple tasks from the database.
public get ( $taskIds ) : Nag_Task
리턴 Nag_Task A Nag_Task object.

getByUID() 공개 메소드

Retrieves one or multiple tasks from the database by UID.
public getByUID ( $uids, array $tasklists = null, boolean $getall = true ) : Nag_Task
$tasklists array An optional array of tasklists to search.
$getall boolean If true, return all instances of the task, otherwise only one. Attempts to find the instance owned by the current user.
리턴 Nag_Task A Nag_Task object.

getChildren() 공개 메소드

Retrieves sub-tasks from the database.
public getChildren ( string $parentId, boolean $include_history = true ) : array
$parentId string The parent id for the sub-tasks to retrieve.
$include_history boolean Include created/modified info?
리턴 array List of sub-tasks.

listAlarms() 공개 메소드

Lists all alarms near $date.
public listAlarms ( integer $date ) : array
$date integer The unix epoch time to check for alarms.
리턴 array An array of tasks that have alarms that match.

retrieve() 공개 메소드

Retrieves tasks from the database.
public retrieve ( integer $completed = Nag::VIEW_ALL, boolean $include_history = true )
$completed integer Which tasks to retrieve (1 = all tasks, 0 = incomplete tasks, 2 = complete tasks, 3 = future tasks, 4 = future and incomplete tasks).
$include_history boolean Include created/changed data from Horde_History.

프로퍼티 상세

$_db 보호되어 있는 프로퍼티

Handle for the current database connection.
protected Horde_Db_Adapter $_db
리턴 Horde_Db_Adapter