Просмотр файла mc-2.7.1/docs/dev.general_functions.html

Размер файла: 8.41Kb
  1. <html>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  5. <title>Документация по MobileCMS</title>
  6. <link rel="stylesheet" href="style.css" type="text/css" />
  7. </head>
  8.  
  9. <body><div class="navheader">
  10. <table width="100%" summary="Navigation header">
  11. <tr>
  12. <th align="center">Документация по MobileCMS</th>
  13. </tr>
  14. <tr>
  15. <th align="center">Главные методы ядра</th>
  16. </tr>
  17. </table>
  18. <hr />
  19. </div>
  20.  
  21. <div class="refsect1">
  22. <h2>Описание</h2>
  23. <p class="classname">
  24. Главные методы ядра находятся в файле <strong class="command">kernel/general_functions.php</strong>
  25. </p>
  26. </div>
  27.  
  28. <div class="refsect1">
  29. <h2>Список основных функций</h2>
  30. <dl>
  31. <dt>
  32. <span class="term">a_import(string file)</span>
  33. </dt>
  34. <dd>
  35. <p>Предназначена для упрощенного подключения php файлов <strong class="command">$file</strong> и вывода ошибки в случае неудачи. Указывать ".php" не обязательно.</p>
  36. <div class="programlisting" style="margin-left: 0px;">
  37. a_import('libraries/j2me_tools');
  38. </div>
  39. </dd>
  40. <dt>
  41. <span class="term">a_url(string path, [string query [, bool header]])</span>
  42. </dt>
  43. <dd>
  44. <p>Предназначенна для упрощения генерации внутренней ссылки.</p>
  45. <ul>
  46. <li><strong class="command">$path</strong> - путь к странице</li>
  47. <li><strong class="command">$query</strong> - GET запроc (не обязательно)</li>
  48. <li><strong class="command">$header</strong> - указывает используется ли ссылка в заголовке или нет (не обязательный параметр)</li>
  49. </ul>
  50. <div class="programlisting" style="margin-left: 0px;">
  51. a_url('guestbook/message_delete', 'message_id=1');
  52. </div>
  53. </dd>
  54. <dt>
  55. <span class="term">a_error([string error_message [, bool fatal_error]])</span>
  56. </dt>
  57. <dd>
  58. <p>Служит для вывода сообщения об ошибке <strong class="command">$error_message</span>, по умолчанию завершает работу системы</p>
  59. <div class="programlisting" style="margin-left: 0px;">
  60. a_error("Сообщение не найдено!");
  61. </div>
  62. </dd>
  63. <dt>
  64. <span class="term">a_notice(string message, string link [, int timeout])</span>
  65. </dt>
  66. <dd>
  67. <p>Служит для вывода информационного сообщения <strong class="command">$message</span> и перенаправления пользователя по ссылке <strong class="command">$link</span>, не обязательный параметр <strong class="command">$timeout</span> указывает на задержку в секундах для перенаправления</p>
  68. <div class="programlisting" style="margin-left: 0px;">
  69. a_notice("Сообщение удалено!", a_url('guestbook'));
  70. </div>
  71. </dd>
  72. <dt>
  73. <span class="term">a_confirm(string message, string link_ok , string link_cancel)</span>
  74. </dt>
  75. <dd>
  76. <p>Служит для вывода подтверждения для выполнения определенного действия</p>
  77. <ul>
  78. <li><strong class="command">$message</strong> - сообщение для подтверждения</li>
  79. <li><strong class="command">$link_ok</strong> - ссылка для подтверждения</li>
  80. <li><strong class="command">$link_cancel</strong> - ссылка для отмены</li>
  81. </ul>
  82. <div class="programlisting" style="margin-left: 0px;">
  83. $message = "Подтверждаете удаление данного сообщения?";<br />
  84. $link_ok = a_url('guestbook/message_delete', 'message_id=1');<br />
  85. $link_cancel = a_url('questbook');<br />
  86. <br />
  87. a_confirm($message, $link_ok, $link_cancel);
  88. </div>
  89. </dd>
  90. <dt>
  91. <span class="term">a_safe(string str)</span>
  92. </dt>
  93. <dd>
  94. <p>Служит для обработки строки <strong class="command">$str</strong> перед помещением ее в базу данных.</p>
  95. </dd>
  96. <dt>
  97. <span class="term">a_debug(mixed var)</span>
  98. </dt>
  99. <dd>
  100. <p>Служит для вывода дампа переменной <strong class="command">$var</strong></p>
  101. </dd>
  102. </dl>
  103. </div>
  104.  
  105. <div><br /><br /></div>
  106.  
  107. <div class="navfooter"><hr />
  108. <table width="100%" summary="Navigation footer">
  109. <tr>
  110. <td width="40%" align="left"><a href="dev.files.html">Пред</a></td>
  111. <td width="20%" align="center"><a href="index.html">На уровень выше</a></td>
  112. <td width="40%" align="right"><a href="dev.module_main.html">След</a></td>
  113. </tr>
  114. <tr>
  115. <td width="40%" align="left" valign="top">Дерево каталогов</td>
  116. <td width="20%" align="center">Содержание</td>
  117. <td width="40%" align="right" valign="top">Методы модуля main</td>
  118. </tr>
  119. </table>
  120. </div>
  121.  
  122. </body>
  123. </html>