תפקיד.קבל

תיאור

integer/array role.get(object parameters)

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

שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.

פרמטרים

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

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

פרמטר סוג תיאור
roleids string/array החזר רק תפקידים עם המזהים הנתונים.
selectRules query כללי תפקיד החזר במאפיין regels.
selectUsers query בחר משתמשים לתפקיד זה מוקצה.
sortfield string/array מיין את התוצאה לפי המאפיינים הנתונים.

ערכים אפשריים הם: roleid, name.
countOutput boolean הפרמטרים הללו הנפוצים לכל שיטות ה-'get' מתוארים בפירוט בדף פרשנות הפניה.
עריכה בוליאנית
excludeSearch בולאני
filter object
limit מספר שלם
פלט שאילתה
preservekeys בולאני
חיפוש אובייקט
searchByAny boolean
searchWildcardsEnabled בוליאני
sortorder מחרוזת/מערך
startSearch boolean

החזר ערכים

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

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

דוגמאות

החזר ערכים

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

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

ראה גם

מקור

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