1 <sect1 id="zend.cache.frontends">
\r
2 <title>الـ frontends المتوفرة فى Zend_Cache</title>
\r
4 <sect2 id="zend.cache.core">
\r
5 <title>Zend_Cache_Core</title>
\r
6 <sect3 id="zend.cache.core.introduction">
\r
9 <code>Zend_Cache_Core</code> هو frontend مميز لأنه جوهر الـ module .
\r
10 هو عبارة cache frontend عام و هناك classes أخرى ممتدة منه.
\r
13 كل الـ frontends ترث من <code>Zend_Cache_Core</code> و بهذا كل الـ methods
\r
14 و الـ options الخاصة به (سيتم توضيحها لاحقاً) متوفرة فى الـ frontends الأخرى , لذلك لن نقوم بشرحها هناك.
\r
17 <sect3 id="zend.cache.core.options">
\r
18 <title>الـ options المتوفرة</title>
\r
20 هذه الـ options يتم تمريرها الى الـ factory method كما كان موضحاً فى امثلة سابقة.
\r
23 <title>الـ options المتوفرة لـ Zend_Cache_Core</title>
\r
27 <entry>الـ Option</entry>
\r
28 <entry>الـ Data Type</entry>
\r
29 <entry>الـ Default Value</entry>
\r
30 <entry>الوصف</entry>
\r
35 <entry><code>caching</code></entry>
\r
36 <entry><code>boolean</code></entry>
\r
37 <entry><code>true</code></entry>
\r
39 تقوم بإقاف او تشغيل عملية الـ caching ( من الممكن ان تكن مفيدة عند عمل debuging للكود الواقع فى
\r
40 نطاق عمل عملية الـ caching ).
\r
44 <entry><code>lifeTime</code></entry>
\r
45 <entry><code>int</code></entry>
\r
46 <entry><code>3600</code></entry>
\r
48 فترة صلاحية الـ cache record (بالثوانى), إن كانت قيمتها تساوى null فسيكون الـ cache record
\r
49 صالح للإستخدام دائما.
\r
53 <entry><code>logging</code></entry>
\r
54 <entry><code>boolean</code></entry>
\r
55 <entry><code>false</code></entry>
\r
57 إن كانت قيمتها تساوى TRUE, سيتم تنشيط عملية الـ loging من خلال <code>Zend_Log</code> .
\r
58 (لكن سيبطئ من عمل النظام نسبياً)
\r
62 <entry><code>writeControl</code></entry>
\r
63 <entry><code>boolean</code></entry>
\r
64 <entry><code>true</code></entry>
\r
66 تقوم بايقاف او تشغيل الـ write control (أى سيتم قرائة الـ cache بعد حفظه للتأكد من
\r
68 تشغيل الـ write control سيتسبب فى ابطاء عملية كتابة "حفظ" الـ cache قليلا, لكنه
\r
69 لن يؤثر فى علية القرائة.
\r
70 (يمكن ان بساعد فى اكتشاف ملفات الـ cache المعطوبة "الفاسدة" و لكنه برغم ذالك لا يعتبر
\r
75 <entry><code>automaticSerialization</code></entry>
\r
76 <entry><code>boolean</code></entry>
\r
77 <entry><code>false</code></entry>
\r
79 تقوم بتشغيل او ايقاف عملية الـ serialization التلقائية , يمكن ان يتم استخدامها عند الحاجة لحفظ
\r
80 بيانات مباشرة , حيث ان هذه البيانات ليست من النوع string.
\r
85 <entry><code>automaticCleaningFactor</code></entry>
\r
86 <entry><code>int</code></entry>
\r
87 <entry><code>10</code></entry>
\r
89 تقوم بتشغيل او ايقاف عملية التنظيف (garbage collector):
\r
90 القيمة 0 تعنى إيقاف عملية التنظيف التلقائى للـ cache ,
\r
91 القيمة 1 تعنى تشغيل عملية التنظيف بشكل منتظم,
\r
92 و عندما تكن القيمة هى x > 1 سيتم تنفيذ عملية تنظيف تلقائى عشوائية لكل عدد x من
\r
101 <sect3 id="zend.cache.core.examples">
\r
102 <title>امثلة</title>
\r
104 تم اعطاء مثال فى بداية هذا الفصل.
\r
107 إن كنت تقم بحفظ بيانات من النوع string فقط فى الـ cache (من الممكن حفظ
\r
108 بيانات من النوع bool ايضا بتشغيل الـ option المسمى "automaticSerialization" ) ,
\r
109 يمكنك ان تستخدم بنية كود ادق مثل هذه :
\r
111 <programlisting role="php"><![CDATA[<?php
\r
113 // we assume you already have $cache
\r
115 $id = 'myBigLoop'; // cache id of "what we want to cache"
\r
117 if (!($data = $cache->load($id))) {
\r
121 for ($i = 0; $i < 10000; $i++) {
\r
122 $data = $data . $i;
\r
125 $cache->save($data);
\r
129 // [...] do something with $data (echo it, pass it on etc.)
\r
131 ?>]]> </programlisting>
\r
133 إن كنت تريد حفظ اكثر من بلوك او مجموعة بيانات مختلفة, فهى نفس الفكرة :
\r
135 <programlisting role="php"><![CDATA[<?php
\r
137 // make sure you use unique identifiers:
\r
142 if (!($data = $cache->load($id1))) {
\r
146 for ($i=0;$i<10000;$i++) {
\r
147 $data = $data . $i;
\r
150 $cache->save($data);
\r
155 // this isn't affected by caching
\r
156 echo('NEVER CACHED! ');
\r
159 if (!($data = $cache->load($id2))) {
\r
163 for ($i=0;$i<10000;$i++) {
\r
164 $data = $data . '!';
\r
167 $cache->save($data);
\r
172 ?>]]> </programlisting>
\r
176 <sect2 id="zend.cache.frontend.output">
\r
177 <title>Zend_Cache_Frontend_Output</title>
\r
178 <sect3 id="zend.cache.frontend.output.introduction">
\r
179 <title>مقدمة</title>
\r
181 <code>Zend_Cache_Frontend_Output</code> هو frontend يستخدم فى التقاط البيانات
\r
182 المخرجة. يستخدم خاصية الـ output buffering التى تقدمها لغة PHP ليلتقط كل شئ يتم اخراجه بين
\r
183 الـ methods المسمى <code>()start</code> و <code>()end</code>.
\r
186 <sect3 id="zend.cache.frontend.output.options">
\r
187 <title>الـ options المتوفرة</title>
\r
189 هذا الـ frontend لا يحتوى اى options جديدة بخلاف الموجودة فى
\r
190 <code>Zend_Cache_Core</code>.
\r
194 <sect3 id="zend.cache.frontend.output.examples">
\r
195 <title>امثلة</title>
\r
197 تم اعطاء مثال فى بداية هذا الفصل, ها هو مع بعض التعديلات الصغيرة:
\r
199 <programlisting role="php"><![CDATA[<?php
\r
201 // if it is a cache miss, output buffering is triggered
\r
202 if(!$cache->start('mypage')):
\r
204 // output everything as usual
\r
205 echo 'Hello world! ';
\r
206 echo 'This is cached ('.time().') ';
\r
208 $cache->end(); // output buffering ends
\r
211 echo 'This is never cached ('.time().').';
\r
213 ?>]]> </programlisting>
\r
215 بإستخدام هذه الطريقة يمكنك بسهولة إدخال خاصية الـ caching لمخرجات الأكواد فى مشروعك بإستخدام القليل او
\r
216 ربما عدم الأحتياج لعمل refactoring.
\r
221 <sect2 id="zend.cache.frontend.function">
\r
222 <title>Zend_Cache_Frontend_Function</title>
\r
223 <sect3 id="zend.cache.frontend.function.introduction">
\r
224 <title>مقدمة</title>
\r
226 تقوم <code>Zend_Cache_Frontend_Function</code> بعمل cache
\r
227 لناتج استدعاء دالة ما, و لديها method واحد رئيسى يسمى <code>()call</code> و الذى
\r
228 يأخذ اسم الدالة المراد استدعائها و array تحتوتى الـ parameters التى سيتم تمريرها لهذه الدالة.
\r
231 <sect3 id="zend.cache.frontend.function.options">
\r
232 <title>الـ options المتوفرة</title>
\r
234 <title>الـ options المتوفرة لـ Zend_Cache_Frontend_Function</title>
\r
238 <entry>الـ Option</entry>
\r
239 <entry>الـ Data Type</entry>
\r
240 <entry>الـ Default Value</entry>
\r
241 <entry>الوصف</entry>
\r
246 <entry><code>cacheByDefault</code></entry>
\r
247 <entry><code>boolean</code></entry>
\r
248 <entry><code>true</code></entry>
\r
250 إن كانت قيمتها true , سيتم تنفيذ عملية الـ cache لكل عملية استدعاء دالة (by default).
\r
254 <entry><code>cachedFunctions</code></entry>
\r
255 <entry><code>array</code></entry>
\r
258 اسماء الـ functions التى سيتم عمل cache لها دائما.
\r
262 <entry><code>nonCachedFunctions</code></entry>
\r
263 <entry><code>array</code></entry>
\r
266 اسماء الـ functions التى لا يجب عمل cache لها ابدا.
\r
274 <sect3 id="zend.cache.frontend.function.examples">
\r
275 <title>امثلة</title>
\r
277 استخدام الـ method المسمى <code>()call</code> هو نفس طريقة استخدام
\r
278 دالة لغة PHP المسمى <code>()call_user_func_array</code> :
\r
280 <programlisting role="php"><![CDATA[<?php
\r
282 $cache->call('veryExpensiveFunc', $params);
\r
284 # $params is an array
\r
285 # for example to call (with caching) veryExpensiveFunc(1, 'foo', 'bar'), you will use
\r
286 # $cache->call('veryExpensiveFunc', array(1, 'foo', 'bar'))
\r
288 ?>]]> </programlisting>
\r
290 <code>Zend_Cache_Frontend_Function</code> ذكية كفاية لتقوم بعمل
\r
291 cache لكل من ناتج الدالة العائد من "return" و البيانات المخرجة داخل الدالة (مثل عمل طباعة
\r
292 لبعض البيانات من داخل الدالة).
\r
295 يمكنك تمرير اى دالة سواء كانت من دوال اللغة او دالة انت انشئتها بإستثناء الدوال التالية :
\r
296 <code>array</code>,
\r
298 <code>empty</code>,
\r
302 <code>isset</code>,
\r
304 , <code>print</code>
\r
306 <code>unset</code>.
\r
311 <sect2 id="zend.cache.frontend.class">
\r
312 <title>Zend_Cache_Frontend_Class</title>
\r
313 <sect3 id="zend.cache.frontend.class.introduction">
\r
314 <title>مقدمة</title>
\r
316 يختلف <code>Zend_Cache_Frontend_Class</code> عن
\r
317 <code>Zend_Cache_Frontend_Function</code> حيث انه
\r
318 يقوم بعمل cache لعمليات استدعاء الـ objects و الـ static methods.
\r
321 <sect3 id="zend.cache.frontend.class.options">
\r
322 <title>الـ options المتوفر</title>
\r
324 <title>الـ options المتوفرة لـ Zend_Cache_Frontend_Class</title>
\r
328 <entry>الـ Option</entry>
\r
329 <entry>الـ Data Type</entry>
\r
330 <entry>الـ Default Value</entry>
\r
331 <entry>الوصف</entry>
\r
336 <entry><code>cachedEntity</code> (مطلوب)</entry>
\r
337 <entry><code>mixed</code></entry>
\r
340 إن كانت قيمتها عبارة عن اسم class, سيتم عمل cache للـ class على انه abstract
\r
341 و سيتم استخدام طلبات الـ static mithods الخاصة به.
\r
342 إذا كانت قيمتها عبارة عن object, سيتم عمل cache لكل الـ methods الخاصة
\r
347 <entry><code>cacheByDefault</code></entry>
\r
348 <entry><code>boolean</code></entry>
\r
349 <entry><code>true</code></entry>
\r
351 إن كانت تحمل القيمة true, كل الطلبات "calls" سيتم عمل cache لها تلقائيا.
\r
355 <entry><code>cachedMethods</code></entry>
\r
356 <entry><code>array</code></entry>
\r
359 اسماء الـ methods التى يستم عمل cache لها دائما.
\r
363 <entry><code>nonCachedMethods</code></entry>
\r
364 <entry><code>array</code></entry>
\r
367 اسماء الـ methods التى لا يجب عمل cache لها ابدا.
\r
375 <sect3 id="zend.cache.frontend.class.examples">
\r
376 <title>امثلة</title>
\r
378 مثال على عمل cache لأستدعائات الـ static methods:
\r
380 <programlisting role="php"><![CDATA[<?php
\r
385 public static function foobar($param1, $param2) {
\r
386 echo "foobar_output($param1, $param2)";
\r
387 return "foobar_return($param1, $param2)";
\r
393 $frontendOptions = array(
\r
394 'cachedEntity' => 'test' // The name of the class
\r
399 $res = $cache->foobar('1', '2');
\r
401 ?>]]> </programlisting>
\r
403 لعمل cache للـ methods العادية:
\r
405 <programlisting role="php"><![CDATA[<?php
\r
409 private $_string = 'hello !';
\r
411 public function foobar2($param1, $param2) {
\r
412 echo($this->_string);
\r
413 echo "foobar2_output($param1, $param2)";
\r
414 return "foobar2_return($param1, $param2)";
\r
420 $frontendOptions = array(
\r
421 'cachedEntity' => new test() // An instance of the class
\r
426 $res = $cache->foobar2('1', '2');
\r
428 ?>]]> </programlisting>
\r
432 <sect2 id="zend.cache.frontends.file">
\r
433 <title>Zend_Cache_Frontend_File</title>
\r
434 <sect3 id="zend.cache.frontends.file.introduction">
\r
435 <title>مقدمة</title>
\r
437 <code>Zend_Cache_Frontend_File</code> هو frontend يعتمد
\r
438 على اخر وقت تعديل ملف معين "master file".
\r
439 يتم استخدامه على سبيل المثال مع ملفات الـ configuration او الملفات التى تخص
\r
443 على سبيل المثال: انت لديك ملف XML يحتوى على الـ configurations الخاصة ببرنامجك,
\r
444 هذا الملف يتم قرائة محتوياته بإستخدام دالة معينة و التى تعيد "return" إلينا "config object"
\r
445 (مثل <code>Zend_Config</code> ).
\r
446 عن طريق <code>Zend_Cache_Frontend_File</code> يمكنك
\r
447 حفظ الـ "config object" فى الـ cache (لتتجنب عملية قرائة ملف الـ XML عند كل مرة)
\r
448 لكن بالأعتماد بشدة على الـ "master file" اى ملف الـ XML.
\r
449 إذاً, إن تم تعديل ملف الـ XML سيتم اعتبار النسخة فى الـ cache غير صالحة للإستخدام و سيتم إنشاء
\r
453 <sect3 id="zend.cache.frontends.file.options">
\r
454 <title>الـ options المتوفرة</title>
\r
456 <title>الـ options المتوفرة لـ Zend_Cache_Frontend_File</title>
\r
460 <entry>الـ Option</entry>
\r
461 <entry>الـ Data Type</entry>
\r
462 <entry>الـ Default Value</entry>
\r
463 <entry>الوصف</entry>
\r
468 <entry><code>masterFile (إجبارى)</code></entry>
\r
469 <entry><code>string</code></entry>
\r
470 <entry><code></code></entry>
\r
472 المسار الكامل للملف "master file".
\r
479 <sect3 id="zend.cache.frontends.file.examples">
\r
480 <title>امثلة</title>
\r
482 إستخدام هذا الـ frontend هو نفس طريقة استخدام <code>Zend_Cache_Core</code>,
\r
483 لذلك لا يوجد حاجة إلى مثال جديد, الشئ الوحيد الذى ستقوم به هو تعريف قيمة
\r
484 <code>masterFile</code> عند إستخدام الـ factory.
\r
489 <sect2 id="zend.cache.frontends.page">
\r
490 <title>Zend_Cache_Frontend_Page</title>
\r
491 <sect3 id="zend.cache.frontends.page.introduction">
\r
492 <title>مقدمة</title>
\r
494 <code>Zend_Cache_Frontend_Page</code> يتشابه مع
\r
495 <code>Zend_Cache_Frontend_Output</code> إلا انه تم تصميمه
\r
496 لعمل cache لصفحة كاملة.
\r
497 فلا يمكن إستخدام <code>Zend_Cache_Frontend_Page</code>
\r
498 لعمل cache لجزء او بلوك معين فقط.
\r
501 على الجانب الأخر, الـ "cache id" يتم حسابه من خلال
\r
502 <code>['SERVER['REQUEST_URI_$</code> و (اعتمادا على قيم الـ options يستخدم التالى)
\r
503 <code>GET</code>, <code>POST</code>,
\r
504 <code>SESSION</code>, <code>COOKIE</code>,
\r
505 <code>FILES</code>.
\r
506 غير ذلك, يجب عليك استدعاء method واحد فقط و هو (<code>()start</code>) لأن
\r
507 <code>()end</code> يتم إستدعائه تلقائيا عند إنتهاء الصفحة.
\r
510 الى هذه اللحظة لم يتم تنفيذه لكننا ننوى إضافة نظام HTTP شرطى لحفظ المذيد من الـ bandwith
\r
511 (سيقوم النظام بإرسال الهيدر "HTTP 304" أى لم يتم تعديل الملف و هذا إذا تم إيجاد نسخة cache
\r
512 قابلة للأستخدام "طازجة" و إذا كان لدى المتصفح ايضا نسخة صالحة "طازجة" من هذه الصفحة.
\r
515 Zend_Cache_Frontend_Page يعتبر فى المرحلة alpha الأن , إى انه سيتم عمل
\r
516 تطويرات جديدة له مع مرور الوقت.
\r
519 <sect3 id="zend.cache.frontends.page.options">
\r
520 <title>الـ options المتوفرة</title>
\r
522 <title>الـ options المتوفرة لـ Zend_Cache_Frontend_Page</title>
\r
526 <entry>الـ Option</entry>
\r
527 <entry>الـ Data Type</entry>
\r
528 <entry>الـ Default Value</entry>
\r
529 <entry>الوصف</entry>
\r
534 <entry><code>httpConditional</code></entry>
\r
535 <entry><code>boolean</code></entry>
\r
536 <entry><code>false</code></entry>
\r
538 إستخدم نظام الـ HTTP الشرطى "httpConditional system" (لم يتم دعمه الى الأن).
\r
542 <entry><code>debugHeader</code></entry>
\r
543 <entry><code>boolean</code></entry>
\r
544 <entry><code>false</code></entry>
\r
546 إن كانت تحمل القيمة true, بيانات الـ debugging سيتم إضافتها قبل كل صفحة لها cache.
\r
550 <entry><code>defaultOptions</code></entry>
\r
551 <entry><code>array</code></entry>
\r
552 <entry><code>(.انظر الوصف.)array</code></entry>
\r
554 associative array تحتوى على الـ default options :
\r
558 <code>(boolean, true by default) cache</code> :
\r
559 إن كانت تحمل قيمة true فالـ cache مفعل
\r
564 <code>(boolean, false by default) cacheWithGetVariables</code> :
\r
565 إن كانت تحمل القيمة true فالـ cache مفعل حتى لو كان هناك قيم فى المصفوفة
\r
571 <code>(boolean, false by default) cacheWithPostVariables</code> :
\r
572 إن كانت تحمل القيمة true فالـ cache مفعل حتى لو كان هناك قيم فى المصفوفة
\r
573 <code>POST_$</code>
\r
578 <code>(boolean, false by default) cacheWithSessionVariables</code> :
\r
579 إن كانت تحمل القيمة true فالـ cache مفعل حتى لو كان هناك قيم فى المصفوفة
\r
580 <code>SESSION_$</code>
\r
585 <code>(boolean, false by default) cacheWithFilesVariables</code> :
\r
586 إن كانت تحمل القيمة true فالـ cache مفعل حتى لو كان هناك قيم فى المصفوفة
\r
587 <code>FILES_$</code>
\r
592 <code>(boolean, false by default) cacheWithCookieVariables</code> :
\r
593 إن كانت تحمل القيمة true فالـ cache مفعل حتى لو كان هناك قيم فى المصفوفة
\r
594 <code>COOKIE_$</code>
\r
599 <code>(boolean, true by default) makeIdWithGetVariables</code> :
\r
600 إن كانت تحمل القيمة true فقيمة الـ "cache id" تعتمد على محتويات المصفوفة
\r
606 <code>(boolean, true by default) makeIdWithPostVariables</code> :
\r
607 إن كانت تحمل القيمة true فقيمة الـ "cache id" تعتمد على محتويات المصفوفة
\r
608 <code>POST_$</code>
\r
613 <code>(boolean, true by default) makeIdWithSessionVariables</code> :
\r
614 إن كانت تحمل القيمة true فقيمة الـ "cache id" تعتمد على محتويات المصفوفة
\r
615 <code>SESSION_$</code>
\r
620 <code>(boolean, true by default) makeIdWithFilesVariables</code> :
\r
621 إن كانت تحمل القيمة true فقيمة الـ "cache id" تعتمد على محتويات المصفوفة
\r
622 <code>FILES_$</code>
\r
627 <code>(boolean, true by default) makeIdWithCookieVariables</code> :
\r
628 إن كانت تحمل القيمة true فقيمة الـ "cache id" تعتمد على محتويات المصفوفة
\r
629 <code>COOKIE_$</code>
\r
636 <entry><code>regexps</code></entry>
\r
637 <entry><code>array</code></entry>
\r
638 <entry><code>array()</code></entry>
\r
640 associative array تضع بها الـ options الخاصة بـ REQUEST_URI.
\r
641 المفتاح "key" سيكون عبارة عن جملة regex من النوع (PCRE), و القيم "values"
\r
642 ستكون عبارة عن associative array تحتوى مجموعة من الـ options التى سيتم
\r
643 تنفيذها إذا توافقت جملة الـ regex مع ['SERVER['REQUEST_URI_$
\r
644 (انظر الى defaultOptions لقائمة بالـ options المتوفرة).
\r
645 إذا توافقت اكثر من جملة regexp مع قيمة ['SERVER['REQUEST_URI_$ , سيتم
\r
646 إستخدام اخر واحد فقط.
\r
653 <sect3 id="zend.cache.frontends.page.examples">
\r
654 <title>امثلة</title>
\r
656 إستخدام Zend_Cache_Frontend_Page سهل جدا :
\r
658 <programlisting role="php"><![CDATA[<?php
\r
660 // [...] // require, configuration and factory
\r
663 // if the cache is hit, the result is sent to the browser and the script stop here
\r
665 // rest of the page ...
\r
667 ?>]]> </programlisting>
\r
669 مثال اكثر تعقيدا يوضح اسلوب لتنفيذ إدارة مركزية للـ cache داخل ملف bootstrap
\r
670 "ملف رئيسى لتشغيل البرنامج".
\r
671 (مثلا للإستخدام مع Zend_Controller)
\r
673 <programlisting role="php"><![CDATA[<?php
\r
675 // [...] you should avoid to put too much lines before the cache section
\r
676 // [...] for example, for optimal performances, "require_once" or "Zend_Loader::loadClass" should be
\r
677 // [...] after the cache section
\r
679 require_once 'Zend/Cache.php';
\r
681 $frontendOptions = array(
\r
682 'lifeTime' => 7200,
\r
683 'debugHeader' => true, // for debuging
\r
684 'regexps' => array(
\r
685 '^/$' => array('cache' => true), // cache the whole IndexController
\r
686 '^/index/' => array('cache' => true), // cache the whole IndexController
\r
687 '^/article/' => array('cache' => false), // we don't cache the ArticleController...
\r
688 '^/article/view/' => array( // ...but we cache the "view" action of
\r
689 'cache' => true, // this ArticleController
\r
690 'cacheWithPostVariables' => true, // and we cache even there are some variables in $_POST
\r
691 'makeIdWithPostVariables' => true, // (but the cache will be dependent of the $_POST array)
\r
695 $backendOptions = array(
\r
696 'cacheDir' => '/tmp/'
\r
699 // getting a Zend_Cache_Frontend_Page object
\r
700 $cache = Zend_Cache::factory('Page', 'File', $frontendOptions, $backendOptions);
\r
703 // if the cache is hit, the result is sent to the browser and the script stop here
\r
705 // [...] the end of the bootstrap file (these lines won't be executed if the cache is hit)
\r
707 ?>]]> </programlisting>
\r