[comment]: # ({619023b5-619023b5})
# תפקיד.קבל

[comment]: # ({/619023b5-619023b5})

[comment]: # ({03201ee2-ed6f4d70})
### תיאור

`integer/array role.get(object parameters)`

השיטה מאפשרת לשלוף תפקידים לפי הפרמטרים הנתונים.

::: noteclassic
שיטה זו זמינה למשתמשים מכל סוג. הרשאות
כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה [משתמש
תפקידים](/manual/web_interface/frontend_sections/administration/user_roles)
למידע נוסף.
:::

[comment]: # ({/03201ee2-ed6f4d70})

[comment]: # ({1b0d288a-3b10ad42})
### פרמטרים

`(object)` פרמטרים המגדירים את הפלט הרצוי.

השיטה תומכת בפרמטרים הבאים.

|פרמטר|[סוג](/manual/api/reference_commentary#data_types)|תיאור|
|--|--|------|
|roleids|string/array|החזר רק תפקידים עם המזהים הנתונים.|
|selectRules|query|כללי תפקיד החזר במאפיין [regels](/manual/api/reference/role/object#role_rules).|
|selectUsers|query|בחר [משתמשים](/manual/api/reference/user/object) לתפקיד זה מוקצה.|
|sortfield|string/array|מיין את התוצאה לפי המאפיינים הנתונים.<br><br>ערכים אפשריים הם: `roleid`, `name`.|
|countOutput|boolean|הפרמטרים הללו הנפוצים לכל שיטות ה-'get' מתוארים בפירוט בדף [פרשנות הפניה](/manual/api/reference_commentary#common_get_method_parameters).|
|עריכה|בוליאנית|^|
|excludeSearch|בולאני|^|
|filter|object|^|
|limit|מספר שלם|^|
|פלט|שאילתה|^|
|preservekeys|בולאני|^|
|חיפוש|אובייקט|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|בוליאני|^|
|sortorder|מחרוזת/מערך|^|
|startSearch|boolean|^|

[comment]: # ({/1b0d288a-3b10ad42})

[comment]: # ({7223bab1-7223bab1})
### החזר ערכים

`(מספר שלם/מערך)` מחזיר אחד:

- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר `countOutput`
     נעשה שימוש.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### דוגמאות

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({7e63506a-ac3322b8})
### החזר ערכים

`(מספר שלם/מערך)` מחזיר אחד:

- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר `countOutput`
     נעשה שימוש.

[comment]: # ({/7e63506a-ac3322b8})

[comment]: # ({f3933c89-f3933c89})
### ראה גם

- [כללי תפקיד](/manual/api/reference/role/object#role_rules)
- [משתמש](/manual/api/reference/user/object#user)

[comment]: # ({/f3933c89-f3933c89})

[comment]: # ({780eeb68-780eeb68})
### מקור

CRole::get()‎ בתוך *ui/include/classes/api/services/CRole.php*.

[comment]: # ({/780eeb68-780eeb68})