Documentation
Table of Contents
מפה.קבל
תיאור
integer/array map.get(object parameters)
השיטה מאפשרת לשלוף מפות לפי הפרמטרים הנתונים.
שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.
פרמטרים
(object) פרמטרים המגדירים את הפלט הרצוי.
השיטה תומכת בפרמטרים הבאים.
| פרמטר | סוג | תיאור |
|---|---|---|
| sysmapids | string/array | מחזיר רק מפות עם המזהים הנתונים. |
| userids | string/array | מחזיר רק מפות השייכות למזהי המשתמש הנתונים. |
| expandUrls | flag | מוסיף כתובות אתרים של מפה גלובלית לרכיבי המפה המתאימים ומרחיב פקודות מאקרו בכל כתובות ה-URL של רכיבי המפה. |
| selectIconMap | query | מחזיר מאפיין iconmap עם מפת הסמלים המשמשת במפה. |
| selectLinks | query | מחזיר מאפיין links עם קישורי המפה בין אלמנטים. |
| selectSelements | query | מחזיר מאפיין selements עם רכיבי המפה. |
| selectUrls | query | מחזיר מאפיין urls עם כתובות האתרים של המפה. |
| selectUsers | query | מחזיר מאפיין משתמשים עם משתמשים שאיתם המפה משותפת. |
| selectUserGroups | query | מחזיר מאפיין userGroups עם קבוצות משתמשים שהמפה משותפת איתן. |
| selectShapes | query | מחזיר מאפיין shapes עם צורות המפה. |
| selectLines | query | מחזיר מאפיין lines עם קווי המפה. |
| sortfield | string/array | מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: name, width ו-height. |
| countOutput | boolean | הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות. |
| עריכה | בוליאנית | |
| excludeSearch | בולאני | |
| filter | object | |
| limit | מספר שלם | |
| פלט | שאילתה | |
| preservekeys | בולאני | |
| חיפוש | אובייקט | |
| searchByAny | boolean | |
| searchWildcardsEnabled | בוליאני | |
| sortorder | מחרוזת/מערך | |
| startSearch | boolean |
החזר ערכים
(מספר שלם/מערך) מחזיר אחד:
- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר
countOutputנעשה שימוש.
דוגמאות
החזר ערכים
(מספר שלם/מערך) מחזיר אחד:
- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר
countOutputנעשה שימוש.
ראה גם
מקור
CMap::get() בתוך ui/include/classes/api/services/CMap.php.