רשימה של פונקציית API

List API Function מספקת שיטות שירות רבות שבהן תוכל להשתמש כדי לקבל נתונים כדרישתך מקטע ה-PHP המותאם אישית שלך או תוסף מותאם אישית.

#אתחול

$listApi = FluentCrmApi('lists');

1

FluentCrmApi('lists') מחזיר בעצם FluentCrm\App\Api\Classes\Lists מופע מחלקות דגם.

#שיטות

#importBulk()

כפי שהשם מרמז, השיטה importBulk  משמשת לייבוא ​​רשימות מרובות בו-זמנית. הוא מקבל מערך של רשימות כטיעון. כל רשימה צריכה להיות מערך של צמדי מפתח-ערך. המפתחות הבאים נדרשים עבור כל רשימה:

/*
* הוסף רשימות בכמויות גדולות
* @param array $lists 
$lists = [
           [
              'title' => 'רשימה 1',
              'שבלול' => 'רשימה-1',
              'description' => 'תיאור אופציונלי'
           ],
           [
               'title' => 'רשימה 2',
               'שבלול' => 'רשימה-2',
               'description' => 'תיאור אופציונלי'
           ]
      ];
* @return: מערך של אובייקטי רשימה
*/
$importedLists = $listApi->importBulk($lists);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

#all()

שיטת האלקנט all תחזיר את כל התוצאות בטבלה של המודל.

/*
* השיטה all מחזירה את המערך הבסיסי המיוצג על ידי אוסף הרשימות
*/
$allLists = $listApi->all();

1
2
3
4

#get()

/*
* הצג רשימה של כל הרשימות של FluentCRM
*/
$lists = $listApi->get();

1
2
3
4

שיטת get מחזירה אוסף המכיל את התוצאות כאשר כל תוצאה היא מופע של אובייקט PHP stdClass. אתה יכול לגשת לערך של כל עמודה על ידי גישה לעמודה כמאפיין של האובייקט:

foreach ($lists בתור $list) {
    echo $list->title;
}

1
2
3

#find()

תוכל לאחזר רשומות בודדות באמצעות שיטת find . במקום להחזיר אוסף של מודלים, שיטות אלה מחזירות מופע מודל יחיד:

/*
* אחזר דגם לפי המפתח הראשי שלו...
* @param: int $id 
* @return: אחזר מודל על ידי התאמת מפתח ראשי
*/
$list = $listApi->find($id);

1
2
3
4
5
6

תוכל גם להתקשר לשיטת מצא עם מערך של מפתחות ראשיים, שיחזיר אוסף של הרשומות התואמות:

$lists = $listApi->find([1, 2, 3]);

1

#first()

בנוסף לשיטת find , תוכל גם להשתמש בשיטה הראשונה כדי לאחזר את הרשומה הראשונה התואמת את השאילתה הנתונה:

$list = $listApi->first();

1

#paginate()

העמודים של FluentCRM משולב עם בונה השאילתות ו ORM ומספק נוח, עימוד קל לשימוש של תוצאות מסד הנתונים מחוץ לקופסה. הטיעון היחיד שאתה צריך להעביר הוא מספר הפריטים בעמוד. בדוגמה זו, נניח שאנו רוצים להציג 15 אנשי קשר בכל דף:

$paginatedLists = $listApi->paginate(15);

1

#getInstance()

אם ברצונך לגשת ישירות למודל FluentCrm\App\Models\Lists ככה אתה משתמש כך

$listIntance = FluentCrmApi('lists')->getInstance();

1

עכשיו אתה יכול להשתמש בכל השיטות של בונה שאילתות או ORM. לדוגמה:

/*
* החזרת רשימות שבהן המזהה הוא 1
*/
$list = $listIntance->where('id', 1)->get(); 

/*
* החזר רשימה ראשונה שבה הסטטוס פעיל
*/
$list = $listIntance->where('status', 'active')->first();