Namespaces

Classes

1: <?php
2: /**
3: * This code is licensed under AGPLv3 license or Afterlogic Software License
4: * if commercial version of the product was purchased.
5: * For full statements of the licenses see LICENSE-AFTERLOGIC and LICENSE-AGPL3 files.
6: */
7:
8: namespace Aurora\Modules\DavContacts\Storages;
9:
10: /**
11: * @license https://www.gnu.org/licenses/agpl-3.0.html AGPL-3.0
12: * @license https://afterlogic.com/products/common-licensing Afterlogic Software License
13: * @copyright Copyright (c) 2023, Afterlogic Corp.
14: */
15: class Storage extends \Aurora\System\Managers\AbstractStorage
16: {
17: /**
18: * @param int $iUserId
19: * @param mixed $mContactId
20: * @return \Aurora\Modules\Contacts\Classes\Contact | false
21: */
22: public function getContactById($iUserId, $mContactId)
23: {
24: return false;
25: }
26:
27: /**
28: * @param int $iUserId
29: * @return \Aurora\Modules\Contacts\Classes\Contact|null
30: */
31: public function GetMyGlobalContact($iUserId)
32: {
33: return null;
34: }
35:
36: /**
37: * @param mixed $mTypeId
38: * @param int $iContactType
39: * @return \Aurora\Modules\Contacts\Classes\Contact|bool
40: */
41: public function GetContactByTypeId($mTypeId, $mContactId)
42: {
43: return false;
44: }
45:
46: /**
47: * @param int $iUserId
48: * @param string $sEmail
49: * @return \Aurora\Modules\Contacts\Classes\Contact|bool
50: */
51: public function getContactByEmail($iUserId, $sEmail)
52: {
53: return false;
54: }
55:
56: /**
57: * @param int $iUserId
58: * @param string $sContactStrId
59: * @return \Aurora\Modules\Contacts\Classes\Contact|bool
60: */
61: public function getContactByStrId($iUserId, $sContactStrId)
62: {
63: return false;
64: }
65:
66: /**
67: * @param int $iUserId
68: * @return array|bool
69: */
70: public function getSharedContactIds($iUserId, $sContactStrId)
71: {
72: return array();
73: }
74:
75:
76: /**
77: * @param \Aurora\Modules\Contacts\Classes\Contact $oContact
78: * @return array|bool
79: */
80: public function getContactGroupIds($oContact)
81: {
82: return array();
83: }
84:
85: /**
86: * @param int $iUserId
87: * @param mixed $mGroupId
88: * @return \Aurora\Modules\Contacts\Classes\Group
89: */
90: public function getGroupById($iUserId, $mGroupId)
91: {
92: return false;
93: }
94:
95: /**
96: * @param int $iUserId
97: * @param string $sGroupStrId
98: * @return \Aurora\Modules\Contacts\Classes\Group
99: */
100: public function getGroupByStrId($iUserId, $sGroupStrId)
101: {
102: return false;
103: }
104:
105: /**
106: * @param int $iUserId
107: * @param string $sName
108: * @return \Aurora\Modules\Contacts\Classes\Group
109: */
110: public function getGroupByName($iUserId, $sName)
111: {
112: return false;
113: }
114:
115: /**
116: * @param int $iUserId
117: * @param int $iOffset
118: * @param int $iRequestLimit
119: * @return bool|array
120: */
121: public function getContactItemsWithoutOrder($iUserId, $iOffset, $iRequestLimit)
122: {
123: return array();
124: }
125:
126: /**
127: *
128: * @param int $iSortField
129: * @param int $iSortOrder
130: * @param int $iOffset
131: * @param int $iRequestLimit
132: * @param array $aFilters
133: * @param int $iIdGroup
134: * @return array
135: */
136: public function getContactItems($iSortField, $iSortOrder, $iOffset, $iRequestLimit, $aFilters, $iIdGroup)
137: {
138: return array();
139: }
140:
141: /**
142: * @param int $iUserId
143: * @param string $sSearch
144: * @param string $sFirstCharacter
145: * @param int $iGroupId
146: * @param int $iTenantId
147: * @return int
148: */
149: public function getContactItemsCount($iUserId, $sSearch, $sFirstCharacter, $iGroupId, $iTenantId = null, $bAll = false)
150: {
151: return 0;
152: }
153:
154: /**
155: * @param int $iUserId
156: * @param int $iSortField
157: * @param int $iSortOrder
158: * @param int $iOffset
159: * @param int $iRequestLimit
160: * @param string $sSearch
161: * @param string $sFirstCharacter
162: * @param int $iContactId
163: * @return bool|array
164: */
165: public function getGroupItems($iUserId, $iSortField, $iSortOrder, $iOffset, $iRequestLimit, $sSearch, $sFirstCharacter, $iContactId)
166: {
167: return array();
168: }
169:
170: /**
171: * @param int $iUserId
172: * @param string $sSearch
173: * @param string $sFirstCharacter
174: * @return int
175: */
176: public function getGroupItemsCount($iUserId, $sSearch, $sFirstCharacter)
177: {
178: return 0;
179: }
180:
181: /**
182: * @param int $iUserId
183: * @param int $iTenantId = 0
184: * @param bool $bAddGlobal = true
185: * @return bool|array
186: */
187: public function GetAllContactsNamesWithPhones($iUserId, $iTenantId = 0, $bAddGlobal = true)
188: {
189: return array();
190: }
191:
192: /**
193: * @param int $iUserId
194: * @param string $sSearch
195: * @param int $iRequestLimit
196: * @param bool $bPhoneOnly = false
197: * @return bool|array
198: */
199: public function GetSuggestContactItems($iUserId, $sSearch, $iRequestLimit, $bPhoneOnly = false)
200: {
201: return array();
202: }
203:
204: /**
205: * @param int $iUserId
206: * @param string $sSearch
207: * @param int $iRequestLimit
208: * @return bool|array
209: */
210: public function GetSuggestGroupItems($iUserId, $sSearch, $iRequestLimit)
211: {
212: return array();
213: }
214:
215: /**
216: * @param \Aurora\Modules\Contacts\Classes\Contact $oContact
217: * @return bool
218: */
219: public function updateContact($oContact)
220: {
221: return false;
222: }
223:
224: /**
225: * @param \Aurora\Modules\Contacts\Classes\Contact $oContact
226: * @param int $iUserId
227: * @return string
228: */
229: public function updateContactUserId($oContact, $iUserId)
230: {
231: return true;
232: }
233:
234: /**
235: * @param \Aurora\Modules\Contacts\Classes\Group $oGroup
236: * @return bool
237: */
238: public function updateGroup($oGroup)
239: {
240: return false;
241: }
242:
243: /**
244: * @param \Aurora\Modules\Contacts\Classes\Contact $oContact
245: * @return bool
246: */
247: public function createContact($oContact)
248: {
249: return false;
250: }
251:
252: /**
253: * @param \Aurora\Modules\Contacts\Classes\Group $oGroup
254: * @return bool
255: */
256: public function createGroup($oGroup)
257: {
258: return false;
259: }
260:
261: /**
262: * @param int $iUserId
263: * @param array $aContactIds
264: * @return bool
265: */
266: public function deleteContacts($iUserId, $aContactIds, $sAddressBook = \Afterlogic\DAV\Constants::ADDRESSBOOK_DEFAULT_NAME)
267: {
268: return true;
269: }
270:
271: /**
272: * @param int $iUserId
273: * @param array $aContactIds
274: * @return bool
275: */
276: public function deleteSuggestContacts($iUserId, $aContactIds)
277: {
278: return true;
279: }
280:
281: /**
282: * @param int $iUserId
283: * @param string $iGroupId
284: * @return bool
285: */
286: public function deleteGroup($iUserId, $iGroupId)
287: {
288: return true;
289: }
290:
291: /**
292: * @param int $iUserId
293: * @param string $sEmail
294: * @return bool
295: */
296: public function updateSuggestTable($iUserId, $aEmails)
297: {
298: return true;
299: }
300:
301: /**
302: * @param int $iUserId
303: * @param array $aContactIds
304: * @return bool
305: */
306: // public function DeleteContactsExceptIds($iUserId, $aContactIds)
307: // {
308: // return true;
309: // }
310:
311: /**
312: * @param int $iUserId
313: * @param array $aGroupIds
314: * @return bool
315: */
316: // public function DeleteGroupsExceptIds($iUserId, $aGroupIds)
317: // {
318: // return true;
319: // }
320:
321: /**
322: * @param \Aurora\Modules\StandardAuth\Classes\Account $oAccount
323: * @return bool
324: */
325: public function clearAllContactsAndGroups($oAccount)
326: {
327: return true;
328: }
329:
330: /**
331: * @return bool
332: */
333: public function flushContacts()
334: {
335: return true;
336: }
337:
338: /**
339: * @param \Aurora\Modules\Contacts\Classes\Group $oGroup
340: * @param array $aContactIds
341: * @return bool
342: */
343: public function addContactsToGroup($oGroup, $aContactIds)
344: {
345: return true;
346: }
347:
348: /**
349: * @param int $iUserId
350: * @param mixed $mContactId
351: * @return \Aurora\Modules\Contacts\Classes\Contact | false
352: */
353: public function GetGlobalContactById($iUserId, $mContactId)
354: {
355: return false;
356: }
357: }
358:
Afterlogic Aurora Corporate 9 API documentation generated by ApiGen v7.0.0-alpha.4