Project

General

Profile

Database » History » Version 2

Panayotis Katsaloulis, 14/12/2013 20:05

1 1 Panayotis Katsaloulis
h1. Σύνδεση με τη βάση δεδομένων μέσω του αντικειμένου Database
2
3
Η σύνδεση με τη βάση δεδομένων από την έκδοση του Open eClass 3 και μετά γίνεται με τη χρήση του αντικειμένου Database που ορίζεται στο  @modules/db/database.php@. Στη κανονική χρήση των ββλιοθηκών το αντικείμενο αυτό παρέχεται στο χρήστη μέσω της @init.php@, οπότε δε χρειάζεται κάποιο @require@ ή @include@ για να χρησιμοποιηθεί, απλά να χρησιμοποιηθούν οι μέθοδοί του. Η υλοποίηση 
4
5
Η πρόσβαση στο αντικείμενο αυτό γίνεται κυρίως με τη static μέθοδο @get()@. Αν είναι δυνατή η κατασκευή ενός τέτοιου αντικειμένου, δεν είναι προτιμόμενη μέθοδος, γιατί μέσω της @get()@ υπάρχουν ορισμένες βελτιστοποιήσεις κατά τη σύνδεση με τη βάση. Σε περίπτωση που θέλουμε να συνδεθούμε στη προκαθορισμένη βάση δεδομένων του eClass τότε η πρόσβαση γίνεται ως εξής:
6 2 Panayotis Katsaloulis
<pre><code class="php">
7 1 Panayotis Katsaloulis
  Database::get();
8 2 Panayotis Katsaloulis
</code></pre>
9 1 Panayotis Katsaloulis
10
Αν θέλουμε να συνδεθούμε σε κάποια άλλη βάση, π.χ. σε ένα μάθημα, τότε δίνουμε στη μέθοδο get() μία παράμετρο. Παράδειγμα, για να συνδεθούμε στη βάση TM001 τότε η σωστή σύνταξη είναι η εξής:
11 2 Panayotis Katsaloulis
<pre><code class="php">
12 1 Panayotis Katsaloulis
  Database::get("TM001");
13 2 Panayotis Katsaloulis
</code></pre>
14 1 Panayotis Katsaloulis
15
Οι μέθοδοι που υποστηρίζονται είναι οι εξής:
16 2 Panayotis Katsaloulis
<pre><code class="php">
17
Database::get()->query($statement);
18
Database::get()->querySingle($statement);
19
Database::get()->queryArray($statement);
20
Database::get()->queryFunc($statement, $callback_function);
21
</code></pre>
22 1 Panayotis Katsaloulis
23 2 Panayotis Katsaloulis
Σε κάθε μία μέθοδο, η πρώτη παράμετρος είναι το επερώτημα SQL που μας ενδιαφέρει να εκτελέσουμε, ακολουθούμενο από μία λίστα με παραμέτρους που θα γίνει εισαγωγή στο επερώτημα. Είναι λάθος πρακτική σε περίπτωση που θέλουμε να εισάγουμε κάποια παράμετρος στο επερώτημα να τη δώσουμε λεκτικά στο επερώτημα αυτό καθ'εαυτό, από το να το δώσουμε σαν επιπρόσθετη παράμετρος. Για να σημειώσουμε στο ίδιο το επερώτημα σε ποιο σημείο είναι η κάθε παράμετρος, χρησιμοποιούμε το σύμβολο «?».
24 1 Panayotis Katsaloulis
25 2 Panayotis Katsaloulis
Για παράδειγμα, αν θέλουμε να εκτελέσουμε το επόμενο επερώτημα SQL
26
<pre><code class="sql">
27 1 Panayotis Katsaloulis
DELETE FROM course_review WHERE course_id = 1;
28 2 Panayotis Katsaloulis
</code></pre> o σωστός τρόπος να συντάξουμε τις παραμέτρους είναι ο εξής:
29
<pre><code class="php">
30
Database::get()->query("DELETE FROM course_review WHERE course_id = ?", 1);
31
</code></pre>
32 1 Panayotis Katsaloulis
33 2 Panayotis Katsaloulis
> *Είναι σημαντικός ο τύπος των παραμέτρων που δίνουμε. Αν αναμένουμε π.χ. πως η παράμετρος είναι ακέραιος, είναι προτιμότερο να δίνεται ως* <code class="php">int_value($param)</code> *αντί για σκέτο* <code class="php">$param</code>
34 1 Panayotis Katsaloulis
35 2 Panayotis Katsaloulis
Πριν τη λίστα με τις παραμέτρους που θα εισαγχθούν στο επερώτημα, είναι δυνατόν να παρέχουμε ως παράμετρο μια συνάρτηση επανάκλησης (_callback function_) ώστε να ενημερωθούμε αν κάτι δε πάει καλά. Υποχρεωτικά αυτή η συνάρτηση θα πρέπει να είναι δεύτερη παράμετρος (ή ειδικά για την @queryFunc@ να είναι τρίτη παράμετρος), αλλιώς θα αγνοηθεί από το σύστημα. Αν η δεύτερη (ή αντίστοιχα τρίτη) παράμετρος δεν είναι συνάρτηση, τότε η δυνατότητα επανάκλησης δε θα ενεργοποιηθεί καθόλου. Ένα παράδειγμα της χρήσης αυτής της μεδόδου δίνεται στη μέθοδο  <code class="php">query($statement)</code> και <code class="php">queryFunc($statement, $callback_function)</code>
36
37 1 Panayotis Katsaloulis
h2. Μέθοδος @query($statement);@
38
39 2 Panayotis Katsaloulis
Με τη μέθοδο αυτή εκτελούμε ένα απλό επερώτημα από το οποίο δεν περιμένουμε αποτελέσματα. Παράδειγμα χρήσης:
40
<pre><code class="php">
41
$cid = 1;
42 1 Panayotis Katsaloulis
Database::get()->query("DELETE FROM course_review WHERE course_id = ?", $cid);
43 2 Panayotis Katsaloulis
</code></pre>
44
45
Σε περίπτωση που μας ενδιεφέρει να ενημερωθούμε αν κάτι δεν έχει πάει καλά, αυτό γίνεται με τη συνάρτηση επανάκλησης, για παράδειγμα ως εξής:
46
<pre><code class="php">
47
$cid = 1;
48
Database::get()->query("DELETE FROM course_review WHERE course_id = ?", function ($errormsg) {
49
        echo "An error has occured: " . $errormsg;
50
    },  $cid);
51
</code></pre>
52
53
54
h2. Μέθοδος @querySingle($statement);@
55
56
Με τη μέθοδο αυτή εκτελούμε ένα επερώτημα από το οποίο περιμένουμε να λάβουμε ως αποτέλεσμα ένα μοναδικό στοιχείο, ή με άλλα λόγια μία και μόνο μία γραμμή. Ο αριθμός των στηλών του αποτελέσματος δεν έχει σημασία. Η σύνταξη είναι ίδια με αυτή της μεθόδου <code class="php">query($statement);</code>
57
58
Ως αποτέλεσμα λαμβάνουμε ένα αντικείμενο όπου κάθε ιδότητά του (property) έχει τιμή ίδια με το όνομα της στήλης σε περιβάλλον SQL. Για το λόγο αυτό είναι προτιμότερο κάθε στήλη να έχει ένα μοναδικό όνομα, ώστε να είναι μετά άμεση η προσπέλαση σε αυτό. Αν δεν υπάρχουν αποτελέσματα επιστρέφεται το @null@, οπότε είναι θεμιτό να γίνεται έλεγχος για @null@ σε περίπτωση που ξέρουμε πως μπορεί να μην υπάρχουν αποτελέσματα. Για παράδειγμα
59
<pre><code class="php">
60
$stat_object = Database::get()->querySingle("SELECT status FROM course_user WHERE user_id = ? AND course_id = ?", $uid, $course_id);
61
if ($stat_object) {
62
  $status = $stat_object->status;
63
}
64
</code></pre> 
65
Ένα άλλο παράδειγμα: <pre><code class="php">
66
$openCoursesNum = Database::get()->querySingle("SELECT COUNT(id) as count FROM course_review WHERE is_certified = 1")->count;
67
</code></pre>
68
69
h2. Μέθοδος @queryArray($statement);@
70
71
Αυτή η μέθοδος εκτελείται όταν περιμένουμε από το επερώτημα να επιστρέψει περισσότερο από ένα στοιχείο (ή γραμμή) και θέλουμε να πάρουμε αμέσως όλα τα αντικείμενα σε έναν πίνακα. Η μέθοδος αυτή μπορεί να χρησιμοποιηθεί σε περίπτωση που περιμένουμε τα αποτελέσματα να είναι λίγα στον αριθμό. Σε περίπτωση που είναι αρκετά, *είναι προτιμότερη η χρήση της μεθόδου @queryFunc@*.
72
73
Η σύνταξη της μεθόδου είναι αντίστοιχη ομοίως της <code class="php">query($statement);</code>
74
75
Η επιστρεφόμενη τιμή είναι ένας πίνακας με αντικείμενα, όπου τα αντικείμενα είναι αντίστοιχα με της μεθόδου <code class="php">querySingle($statement);</code>
76
77
Παράδειγμα χρήσης της μεθόδου
78
79
<pre><code class="php">
80
$moduleIDs = Database::get()->queryArray("SELECT module_id FROM course_module WHERE visible = 1 AND course_id = ?", $course_id);
81
foreach ($moduleIDs as $module) {
82
  $publicModules[] = $module->module_id;
83
}
84
</code></pre>
85
86
h2. Μέθοδος @queryFunc($statement, $callback_function);@
87
88
Η μέθοδος αυτή αναφέρεται σε επερωτήματα που μπορεί να έχουν πολλά αποτελέσματα, αλλά σε αντίθεση με την @queryArray@ λαμβάνουμε ένα αποτέλεσμα τη φορά. Αυτή η συνάρτηση είναι ιδανική όταν τα αποτελέσματα που αναμένουμε είναι αρκετά, αλλά είναι εξίσου χρήσιμη σε περίπτωση που περιμένουμε λίγα, ένα ή και καθόλου αποτελέσματα.
89
90
Ως δεύτερη παράμετρο δίνουμε μία function με μία και μοναδική παράμετρο, όπου θα αποθηκευτεί το τρέχον αποτέλεσμα της εκτέλεσης του επερωτήματος για κάθε _γραμμή_ (σε σύνταξη SQL). Η σύνταξη της παραμέτρου αυτής είναι ίδια με τη σύνταξη της συνάρτησης επανάκλησης σε περίπτωση λάθους, όπως αναφέρθηκε προηγουμένως.
91
92
Επειδή η ορατότητα των εξωτερικών μεταβλητών μέσα στη συνάρτηση είναι περιορισμένη, μπορούμε να χρησιμοποιήσουμε το λεκτικό <code class="php">use($param1, &$param2 ...)</code>, ώστε να ενημερώσουμε την PHP πως ενδιαφερόμαστε να χρησιμοποιήσουμε τις μεταβλητές @$param1@  και @$param2@ εσωτερικά στη συνάρτησή μας. Ειδικά για τη παράμετρο @$param2@, με τη χρήση του συμβόλου @&@ υποδηλώνουμε πως η γίνεται «καθ'αναφορά» η δήλωση της μεταβλητής, δηλαδή οποιαδήποτε αλλαγή που θα γίνει εσωτερικά, θα αλλάζει συνολικά την τιμή της μεταβλητής αυτής.
93
94
Ένα απλό παράδειγμα της μεθόδου αυτής είναι το εξής:
95
<pre><code class="php">
96
DataBase::get()->queryFunc("SELECT title  FROM course_units WHERE course_id = ?", function($unit) {
97
    echo "title: " . $unit->title;
98
  }, intval($courseId));</code></pre>
99
100
Ένα πλήρες παράδειγμα και με συνάρτησης επανάκλησης σε περίπτωση λάθους:
101
<pre><code class="php">
102
$counter = 0;
103
Database::get()->queryFunc("SELECT course.id as cid, course.code as code, FROM course WHERE course.id = ?" , function ($course_info) use ($outer_variable, &$counter, &$title) {
104
    $counter++;
105
    echo "For item #" . $counter . " with outer variable " . $outer_variable . " the course id is . " $course_info->id . " while the course code is " . $course_info->code;
106
  } , function ($errormsg) use($urlServer) {
107
    echo "Error " . $errormsg . " while connected on " . $urlServer;
108
                exit();
109
  } , $dbname);
110
</code></pre>