Overview

Namespaces

  • JohnRivs
    • Wunderlist

Classes

  • JohnRivs\Wunderlist\Wunderlist

Traits

  • JohnRivs\Wunderlist\Authorization
  • JohnRivs\Wunderlist\Avatar
  • JohnRivs\Wunderlist\Comment
  • JohnRivs\Wunderlist\File
  • JohnRivs\Wunderlist\Folder
  • JohnRivs\Wunderlist\Lists
  • JohnRivs\Wunderlist\Note
  • JohnRivs\Wunderlist\Reminder
  • JohnRivs\Wunderlist\Subtask
  • JohnRivs\Wunderlist\Task
  • JohnRivs\Wunderlist\User
  • JohnRivs\Wunderlist\Webhook
  • Overview
  • Namespace
  • Class
 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 
<?php namespace JohnRivs\Wunderlist;

trait Note {

    /**
     * Show all the notes in a list or task.
     *
     * @param  string $entity A list or a task.
     * @param  array $attributes
     * @return array
     */
    public function getNotes($entity, array $attributes = [])
    {
        $this->requires(["{$entity}_id"], $attributes);

        return $this->call('GET', 'notes', ['query' => $attributes]);
    }

    /**
     * Show a note.
     *
     * @param  int $noteId The id of the note.
     * @return array
     */
    public function getNote($noteId)
    {
        return $this->call('GET', "notes/{$noteId}");
    }

    /**
     * Create a new note for a task.
     *
     * @param  array $attributes
     * @return array
     */
    public function createNote(array $attributes = [])
    {
        $this->requires(['task_id', 'content'], $attributes);

        return $this->call('POST', 'notes', ['json' => $attributes]);
    }

    /**
     * Update a note.
     *
     * @param  int $noteId The id of the note.
     * @param  array $attributes
     * @return array
     */
    public function updateNote($noteId, array $attributes = [])
    {
        $attributes['revision'] = $this->getNote($noteId)['revision'];

        $this->requires(['revision', 'content'], $attributes);

        return $this->call('PATCH', "notes/{$noteId}", ['json' => $attributes]);
    }

    /**
     * Delete a note.
     *
     * @param  int $noteId The id of the note.
     * @return array
     */
    public function deleteNote($noteId)
    {
        $attributes['revision'] = $this->getNote($noteId)['revision'];

        $this->requires(['revision'], $attributes);

        $this->call('DELETE', "notes/{$noteId}", ['query' => $attributes]);

        return $this->getStatusCode();
    }

    /**
     * Deletes all notes in a list or task.
     *
     * @param  string $entity A list or a task.
     * @param  array $attributes
     * @return int
     */
    public function deleteNotes($entity, array $attributes = [])
    {
        $this->requires(["{$entity}_id"], $attributes);

        $notes = $this->getNotes($entity, $attributes);

        foreach ($notes as $note) {
            $this->deleteNote($note['id']);
        }

        return $this->getStatusCode();
    }

}
API documentation generated by ApiGen