forked from loduis/teamwork.com-project-management
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Notebook.php
160 lines (150 loc) · 4.18 KB
/
Notebook.php
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<?php
namespace TeamWorkPm;
class Notebook extends Rest\Model
{
protected function init()
{
$this->fields = array(
'name' => true,
'description'=>true,
'content'=>true,
'notify'=>false,
'category_id'=>array(
'required'=>false,
'attributes'=>array(
'type'=>'integer'
)
),
'category_name'=> false,
'private'=>array(
'required'=>false,
'attributes'=>array(
'type'=>'boolean'
)
)
);
}
public function get($id, $params = null)
{
$id = (int) $id;
if ($id <= 0) {
throw new Exception('Invalid param id');
}
return $this->rest->get("$this->action/$id", $params);
}
/**
* List All Notebooks
*
* GET /notebooks.xml?includeContent=[true|false]
*
* Lists all notebooks on projects that the authenticated user is associated with.
* By default, the actual notebook HTML content is not returned.
* You can pass includeContent=true to return the notebook HTML content with the notebook data
*
* @return TeamWorkPm\Response\Model
*/
public function getAll($include_content = false)
{
$include_content = (bool) $include_content;
return $this->rest->get("$this->action", array(
'includeContent'=>$include_content ? 'true' : 'false'
));
}
/**
* List Notebooks on a Project
*
* GET /projects/#{project_id}/notebooks.xml
*
* This lets you query the list of notebooks for a project.
* By default, the actual notebook HTML content is not returned.
* You can pass includeContent=true to return the notebook HTML content with the notebook data
*
* @param int $project_id
* @return TeamWorkPm\Response\Model
*/
public function getByProject($project_id, $include_content = false)
{
$project_id = (int) $project_id;
if ($project_id <= 0) {
throw new Exception('Invalid param project_id');
}
$include_content = (bool) $include_content;
return $this->rest->get("projects/$project_id/$this->action", array(
'includeContent'=>$include_content ? 'true' : 'false'
));
}
/**
* Lock a Single Notebook For Editing
*
* PUT /notebooks/#{id}/lock
*
* Locks the notebook and all versions for editing.
*
* @param type $id
* @return bool
*/
public function lock($id)
{
$id = (int) $id;
if ($id <= 0) {
throw new Exception('Invalid param id');
}
return $this->rest->put("$this->action/$id/lock");
}
/**
* Unlock a Single Notebook
*
* PUT /notebooks/#{id}/unlock
*
* Unlocks a locked notebook so it can be edited again.
*
* @param type $id
* @return bool
*/
public function unlock($id)
{
$id = (int) $id;
if ($id <= 0) {
throw new Exception('Invalid param id');
}
return $this->rest->put("$this->action/$id/unlock");
}
/**
* Create a Single Notebook
*
* POST /projects/#{project_id}/notebooks
* This command will create a single notebook.
* Content must be valid XHMTL
* You not not need to include <html>, <head> or <body> tags
*/
public function insert(array $data)
{
$project_id = empty($data['project_id']) ? 0: (int) $data['project_id'];
if ($project_id <= 0) {
throw new \TeamWorkPm\Exception('Required field project_id');
}
return $this->rest->post("projects/$project_id/$this->action", $data);
}
/**
*
* @param array $data
* @return bool
*/
final public function save(array $data)
{
return $this->insert($data);
}
/**
*
* @param int $id
* @return bool
*/
public function delete($id)
{
$id = (int) $id;
if ($id <= 0) {
throw new Exception('Invalid param id');
}
return $this->rest->delete("$this->action/$id");
}
}