Open eClass

h1. Σύνδεση με τη βάση δεδομένων μέσω του αντικειμένου Database

Η σύνδεση με τη βάση δεδομένων από την έκδοση του Open eClass 3 και μετά γίνεται με τη χρήση του αντικειμένου Database που ορίζεται στο  @modules/db/database.php@. Στη κανονική χρήση των βιβλιοθηκών το αντικείμενο αυτό παρέχεται στο χρήστη μέσω της @init.php@, οπότε δε χρειάζεται κάποιο @require@ ή @include@ για να χρησιμοποιηθεί, απλά να χρησιμοποιηθούν οι μέθοδοί του.

Η πρόσβαση στο αντικείμενο αυτό γίνεται κυρίως με τη static μέθοδο @get()@. Αν και είναι δυνατή η κατασκευή ενός τέτοιου αντικειμένου, δεν είναι προτιμόμενη μέθοδος, γιατί μέσω της @get()@ υπάρχουν ορισμένες βελτιστοποιήσεις κατά τη σύνδεση με τη βάση. Σε περίπτωση που θέλουμε να συνδεθούμε στη προκαθορισμένη βάση δεδομένων του eClass τότε η πρόσβαση γίνεται ως εξής:

<pre><code class="php">

  Database::get();

</code></pre>

Αν υπάρχει ανάγκη σύνδεσης σε κάποια άλλη βάση,  τότε δίνουμε στη μέθοδο get() μία παράμετρο. Παράδειγμα, για να συνδεθούμε στη βάση TM001 τότε η σωστή σύνταξη είναι η εξής:

<pre><code class="php">

  Database::get("TM001");

</code></pre>

Οι μέθοδοι που υποστηρίζονται είναι οι εξής:

<pre><code class="php">

// Transactional Methods

Database::get()->query($statement);

Database::get()->querySingle($statement);

Database::get()->queryArray($statement);

Database::get()->queryFunc($statement, $callback_function);

// Non-Transactional Methods

Database::get()->queryNT($statement);

Database::get()->querySingleNT($statement);

Database::get()->queryArrayNT($statement);

Database::get()->queryFuncNT($statement, $callback_function);

</code></pre>

Υπάρχουν δύο οικογένειες μεθόδων, οι transactional και η not-transactional. Η πρώτη κατηγορία είναι η προτιμώμενη μέθοδος οποτεδήποτε γίνεται ένα επερώτημα. Στην περίπτωση που βρισκόμαστε όμως εν μέσω ενός επερωτήματος και επιθυμούμε να εκτελέσουμε ένα «εσωτερικό» χωρίς ακόμα να έχει τελειώσει το «εξωτερικό» επερώτημα, τότε υποχρεωτικά το εσωτερικό επερώτημα πρέπει να μην είναι transactional γιατί αυτό δεν υποστηρίζεται από τη βάση δεδομένων. Τέτοια περίπτωση είναι πρακτικά κάθε φορά που στην @$callback_function@ της μεθόδου @queryFunc@ θέλουμε να εκτελέσουμε ένα επερώτημα. Τότε όλα ανεξαιρέτως τα επερωτήματα μέσα στη  @$callback_function@ πρέπει να είναι non-transactional, εφόσον η ίδια η πρώτη κλήση στη @queryFunc@ πρέπει να είναι transactional.

Η αντιστοιχία των μεθόδων είναι ως εξής:

|_. transactional |_. non-transactional |

| query  | queryNT  |

| querySingle  | querySingleNT |

| queryArray  | queryArrayNT |

| queryFunc  | queryFuncNT  |

Σε κάθε μία μέθοδο, η πρώτη παράμετρος είναι το επερώτημα SQL που μας ενδιαφέρει να εκτελέσουμε, ακολουθούμενο από μία λίστα με παραμέτρους που θα γίνει εισαγωγή στο επερώτημα. Είναι λάθος πρακτική σε περίπτωση που θέλουμε να εισάγουμε κάποια παράμετρο στο επερώτημα να τη δώσουμε λεκτικά στο επερώτημα αυτό καθ'εαυτό, από το να το δώσουμε σαν επιπρόσθετη παράμετρο. Για να σημειώσουμε στο ίδιο το επερώτημα σε ποιο σημείο είναι η κάθε παράμετρος, χρησιμοποιούμε το σύμβολο «?» ακολουθούμενο από ένα γράμμα που δηλώνει τον τύπο της παραμέτρου. Σε περίπτωση που ως μία παράμετρο δωθεί πίνακας, τότε ο πίνακας θα αναλυθεί στα επιμέρους στοιχεία του με τη σειρά με την οποία εμφανίζονται, ώστε το τελικό αποτέλεσμα των παραμέτρων τελικά να είναι ένας μονοδιάστατος πίνακας, ανεξάρτητα από την επιμέρους δομή των αρχικών παραμέτρων. 

Στον επόμενο πίνακα φαίνονται οι αντιστοιχίες τύπων και χαρακτήρων. Η αντιστοιχία είναι όμοια με αυτή της @printf@ της @stdio@ της C, ή του @java.util.Formatter@ της Java, μόνο που αντί για @%@ χρησιμοποιείται ο @?@:

|_. Χαρακτήρας |_. Τύπος παραμέτρου |

| @?d@  | ακέραιος αριθμός |

| @?b@  | διαδικός (true/false)  |

| @?f@  | δεκαδικός αριθμός  |

| @?s@  | συμβολοσειρά  |

Για παράδειγμα, αν θέλουμε να εκτελέσουμε το επόμενο επερώτημα SQL

<pre><code class="sql">

DELETE FROM course_review WHERE course_id = 1;

</code></pre> o σωστός τρόπος να συντάξουμε τις παραμέτρους είναι ο εξής:

<pre><code class="php">

Database::get()->query("DELETE FROM course_review WHERE course_id = ?d", 1);

</code></pre>

*Δεν* είναι απαραίτητο να εσωκλείεται η παράμετρος σε μία βοηθητική συνάρτηση που να ορίζει ρητά τον τύπο της, σαν τις @int_val@ κλπ. αφού η διαδικασία αυτή εκτελείται αυτόματα από τη βιβλιοθήκη.  Σε περίπτωση που δε δωθεί ρητά ο τύπος, αυτό θα εγείρει μήνυμα λάθους που θα σημειώνεται το επερώτημα, σε ποιο σημείο δεν δηλώθηκε ρητά ο τύπος της παραμέτρου, ποια είναι η τρέχουσα τιμή και τι υπέθεσε το σύστημα πως είναι η τιμή αυτή.  

Πριν τη λίστα με τις παραμέτρους που θα εισαγχθούν στο επερώτημα, είναι δυνατόν να παρέχουμε ως παράμετρο μια συνάρτηση επανάκλησης (_callback function_) ώστε να ενημερωθούμε αν κάτι δε πάει καλά. Υποχρεωτικά αυτή η συνάρτηση θα πρέπει να είναι δεύτερη παράμετρος (ή ειδικά για την @queryFunc@ να είναι τρίτη παράμετρος), αλλιώς θα αγνοηθεί από το σύστημα. Αν η δεύτερη (ή αντίστοιχα τρίτη) παράμετρος δεν είναι συνάρτηση, τότε η δυνατότητα επανάκλησης δε θα ενεργοποιηθεί καθόλου. Ένα παράδειγμα της χρήσης αυτής της μεδόδου δίνεται στη μέθοδο  <code class="php">query($statement)</code> και <code class="php">queryFunc($statement, $callback_function)</code>

h2. Μέθοδος @query($statement);@

Με τη μέθοδο αυτή εκτελούμε ένα απλό επερώτημα. Η επιστρεφόμενη τιμή αυτής της συνάρτησης είναι ένα αντικείμενο τύπου <code class="php">DBResult</code>. Παράδειγμα χρήσης:

<pre><code class="php">

$cid = 1;

$affectedRows = Database::get()->query("DELETE FROM course_review WHERE course_id = ?d", $cid)->affectedRows;

</code></pre>

Το αντικείμενο <code class="php">DBResult</code> έχει δύο ιδιότητες, την <code class="php">$lastInsertID</code> και την <code class="php">$affectedRows</code>. Μπορούμε να χρησιμοποιήσουμε αυτές τις τιμές δεδομένου του συγκεκριμένου επερωτήματος. 

Σε περίπτωση που μας ενδιεφέρει να ενημερωθούμε αν κάτι δεν έχει πάει καλά, αυτό γίνεται με τη συνάρτηση επανάκλησης, για παράδειγμα ως εξής:

<pre><code class="php">

$cid = 1;

Database::get()->query("DELETE FROM course_review WHERE course_id = ?d", function ($errormsg) {

        echo "An error has occured: " . $errormsg;

    },  $cid);

</code></pre>

h2. Μέθοδος @querySingle($statement);@

Με τη μέθοδο αυτή εκτελούμε ένα επερώτημα από το οποίο περιμένουμε να λάβουμε ως αποτέλεσμα ένα μοναδικό στοιχείο, ή με άλλα λόγια μία και μόνο μία γραμμή. Ο αριθμός των στηλών του αποτελέσματος δεν έχει σημασία. Η σύνταξη είναι ίδια με αυτή της μεθόδου <code class="php">query($statement);</code>

Ως αποτέλεσμα λαμβάνουμε ένα αντικείμενο όπου κάθε ιδότητά του (property) έχει τιμή ίδια με το όνομα της στήλης σε περιβάλλον SQL. Για το λόγο αυτό είναι προτιμότερο κάθε στήλη να έχει ένα μοναδικό όνομα, ώστε να είναι μετά άμεση η προσπέλαση σε αυτό. Αν δεν υπάρχουν αποτελέσματα επιστρέφεται το @null@, οπότε είναι θεμιτό να γίνεται έλεγχος για @null@ σε περίπτωση που ξέρουμε πως μπορεί να μην υπάρχουν αποτελέσματα. Για παράδειγμα

<pre><code class="php">

$stat_object = Database::get()->querySingle("SELECT status FROM course_user WHERE user_id = ?d AND course_id = ?d", $uid, $course_id);

if ($stat_object) {

  $status = $stat_object->status;

}

</code></pre> 

Ένα άλλο παράδειγμα: <pre><code class="php">

$openCoursesNum = Database::get()->querySingle("SELECT COUNT(id) as count FROM course_review WHERE is_certified = 1")->count;

</code></pre>

h2. Μέθοδος @queryArray($statement);@

Αυτή η μέθοδος εκτελείται όταν περιμένουμε από το επερώτημα να επιστρέψει περισσότερο από ένα στοιχείο (ή γραμμή) και θέλουμε να πάρουμε αμέσως όλα τα αντικείμενα σε έναν πίνακα. Η μέθοδος αυτή μπορεί να χρησιμοποιηθεί σε περίπτωση που περιμένουμε τα αποτελέσματα να είναι λίγα στον αριθμό. Σε περίπτωση που είναι αρκετά, *είναι προτιμότερη η χρήση της μεθόδου @queryFunc@*.

Η σύνταξη της μεθόδου είναι αντίστοιχη ομοίως της <code class="php">query($statement);</code>

Η επιστρεφόμενη τιμή είναι ένας πίνακας με αντικείμενα, όπου τα αντικείμενα είναι αντίστοιχα με της μεθόδου <code class="php">querySingle($statement);</code>

Παράδειγμα χρήσης της μεθόδου

<pre><code class="php">

$moduleIDs = Database::get()->queryArray("SELECT module_id FROM course_module WHERE visible = 1 AND course_id = ?d", $course_id);

foreach ($moduleIDs as $module) {

  $publicModules[] = $module->module_id;

}

</code></pre>

h2. Μέθοδος @queryFunc($statement, $callback_function);@

Η μέθοδος αυτή αναφέρεται σε επερωτήματα που μπορεί να έχουν πολλά αποτελέσματα, αλλά σε αντίθεση με την @queryArray@ λαμβάνουμε ένα αποτέλεσμα τη φορά. Αυτή η συνάρτηση είναι ιδανική όταν τα αποτελέσματα που αναμένουμε είναι αρκετά, αλλά είναι εξίσου χρήσιμη σε περίπτωση που περιμένουμε λίγα, ένα ή και καθόλου αποτελέσματα.

Ως δεύτερη παράμετρο δίνουμε μία function με μία και μοναδική παράμετρο, όπου θα αποθηκευτεί το τρέχον αποτέλεσμα της εκτέλεσης του επερωτήματος για κάθε _γραμμή_ (σε σύνταξη SQL). Η σύνταξη της παραμέτρου αυτής είναι ίδια με τη σύνταξη της συνάρτησης επανάκλησης σε περίπτωση λάθους, όπως αναφέρθηκε προηγουμένως.

Επειδή η ορατότητα των εξωτερικών μεταβλητών μέσα στη συνάρτηση είναι περιορισμένη, μπορούμε να χρησιμοποιήσουμε το λεκτικό <code class="php">use($param1, &$param2 ...)</code>, ώστε να ενημερώσουμε την PHP πως ενδιαφερόμαστε να χρησιμοποιήσουμε τις μεταβλητές @$param1@  και @$param2@ εσωτερικά στη συνάρτησή μας. Ειδικά για τη παράμετρο @$param2@, με τη χρήση του συμβόλου @&@ υποδηλώνουμε πως η γίνεται «καθ'αναφορά» η δήλωση της μεταβλητής, δηλαδή οποιαδήποτε αλλαγή που θα γίνει εσωτερικά, θα αλλάζει συνολικά την τιμή της μεταβλητής αυτής.

Ένα απλό παράδειγμα της μεθόδου αυτής είναι το εξής:

<pre><code class="php">

DataBase::get()->queryFunc("SELECT title  FROM course_units WHERE course_id = ?d", function($unit) {

    echo "title: " . $unit->title;

  }, intval($courseId));</code></pre>

Ένα πλήρες παράδειγμα και με συνάρτησης επανάκλησης σε περίπτωση λάθους:

<pre><code class="php">

$counter = 0;

Database::get()->queryFunc("SELECT course.id as cid, course.code as code, FROM course WHERE course.id = ?d" , function ($course_info) use ($outer_variable, &$counter, &$title) {

    $counter++;

    echo "For item #" . $counter . " with outer variable " . $outer_variable . " the course id is . " $course_info->id . " while the course code is " . $course_info->code;

  } , function ($errormsg) use($urlServer) {

    echo "Error " . $errormsg . " while connected on " . $urlServer;

    exit();

  } , $dbname);

</code></pre>

Να υπενθυμίσουμε πως αν θέλουμε να εκτελέσουμε ένα άλλο επερώτημα μέσα στη @callback_function@, τότε τα επερωτήματα μέσα θα πρέπει να είναι *non-transactional*.