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

Конкурс дизайнеров на 15000 рублей
Милый пушистый сайт !!!!
Размер файла: 9.71Kb 
  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">Методы модуля main</th>
  16.                     </tr>
  17.                 </table>
  18.                 <hr />
  19.             </div>
  20.  
  21.             <div class="refsect1">
  22.                 <h2>Описание</h2>
  23.                 <p class="classname">
  24.                     Методы модуля main находятся в файле <strong class="command">modules/main/helpers/main.php</strong>, они предназначены для упрощения каких-либо часто выполняемых задач.
  25.                 </p>
  26.             </div>
  27.  
  28.             <div class="refsect1">
  29.                 <h2>Список наиболее употребляемых методов</h2>
  30.                 <dl>
  31.                     <dt>
  32.                         <span class="term">main::wtext(string str)</span>
  33.                     </dt>
  34.                     <dd>
  35.                         <p>Предназначена для смены кодировки строки <strong class="command">$str</strong> из utf-8 в cp-1251</p>
  36.                     </dd>
  37.                     <dt>
  38.                         <span class="term">main::utext(string str)</span>
  39.                     </dt>
  40.                     <dd>
  41.                         <p>Предназначена для смены кодировки строки <strong class="command">$str</strong> из cp-1251 в utf-8</p>
  42.                     </dd>
  43.                     <dt>
  44.                         <span class="term">main::get_unique_code([int length])</span>
  45.                     </dt>
  46.                     <dd>
  47.                         <p>Служит для генерации случайной строки длиной $lenght, но не более 32 символов.</p>
  48.                     </dd>
  49.                     <dt>
  50.                         <span class="term">main::translite(string str)</span>
  51.                     </dt>
  52.                     <dd>
  53.                         <p>Преобразование строки из транслита в кирилицу</p>
  54.                     </dd>
  55.                     <dt>
  56.                         <span class="term">main::end_str(int count, string k_1, string k_234, string k_many)</span>
  57.                     </dt>
  58.                     <dd>
  59.                         <p>Подстраивает нужное окончание</p>
  60.                         <div class="programlisting" style="margin-left: 0px;">
  61.                             echo 5 .' '. main::end_str(5, 'штука', 'штуки', 'штук');
  62.                         </div>
  63.                         <p>Выведет</p>
  64.                         <div class="programlisting" style="margin-left: 0px;">
  65.                             5 штук
  66.                         </div>
  67.                     </dd>
  68.                     <dt>
  69.                         <span class="term">main::strlen(string str)</span>
  70.                     </dt>
  71.                     <dd>
  72.                         <p>Возвращает длину строки для utf-8 (заменяет mb_strlen)</p>
  73.                     </dd>
  74.                     <dt>
  75.                         <span class="term">main::substr(string str, int start [, int lenght])</span>
  76.                     </dt>
  77.                     <dd>
  78.                         <p>Аналог php функции substr(), корректно работающая с utf-8</p>
  79.                     </dd>
  80.                     <dt>
  81.                         <span class="term">main::limit_words(string str, int limit)</span>
  82.                     </dt>
  83.                     <dd>
  84.                         <p>Обрезание части строки по словам</p>
  85.                         <div class="programlisting" style="margin-left: 0px;">
  86.                             $string = "MobileCMS - система управления контентом мобильных сайтов";<br />
  87.                             echo main::limit_words($string, 4);
  88.                         </div>
  89.                         <p>Выведет</p>
  90.                         <div class="programlisting" style="margin-left: 0px;">
  91.                             MobileCMS - система управления
  92.                         </div>
  93.                     </dd>
  94.                     <dt>
  95.                         <span class="term">main::delete_dir(string dir [, bool clear])</span>
  96.                     </dt>
  97.                     <dd>
  98.                         <p>Рекурсивное удаление не пустой папки, если второй параметер равен <strong class="command">true</strong> папка будет очищена от файлов и папок, но удаление самой папки не произойдет</p>
  99.                     </dd>
  100.                     <dt>
  101.                         <span class="term">main::byte_format(mixed num)</span>
  102.                     </dt>
  103.                     <dd>
  104.                         <p>Формирует строку на основе полученного числа как количества байтов. Так же добавляется суффикс. Взята из CodeIgniter.</p>
  105.                         <div class="programlisting" style="margin-left: 0px;">
  106.                             echo byte_format(456); // Возвращает 456 Bytes<br />
  107.                             echo byte_format(4567); // Возвращает 4.5 KB<br />
  108.                             echo byte_format(45678); // Возвращает 44.8 KB<br />
  109.                             echo byte_format(456789); // Возвращает 447.8 KB<br />
  110.                             echo byte_format(3456789); // Возвращает 3.3 MB<br />
  111.                             echo byte_format(12345678912345); // Возвращает 1.8 GB<br />
  112.                             echo byte_format(123456789123456789); // Возвращает 11,228.3 TB		
  113.                         </div>
  114.                     </dd>
  115.                     <dt>
  116.                         <span class="term">main::image_resize(string infile, string outfile [, int neww [, int newh [, int quality]]])</span>
  117.                     </dt>
  118.                     <dd>
  119.                         <p>Функция изменяет формат, размеры и качество изображений</p>
  120.                         <ul>
  121.                             <li><strong class="command">$infile</strong> - исходный файл изображения</li>
  122.                             <li><strong class="command">$outfile</strong> - получаемый файл изображения</li>
  123.                             <li><strong class="command">$neww</strong> - новая ширина изображения (не обязательный параметр)</li>
  124.                             <li><strong class="command">$newh</strong> - новая высота изображения (не обязательный параметр)</li>
  125.                             <li><strong class="command">$quality</strong> - новое качество изображения (не обязательный параметр)</li>
  126.                         </ul>
  127.                         <div class="programlisting" style="margin-left: 0px;">
  128.                             main::image_resize(ROOT .'tmp/src.gif', ROOT .'tmp/dest.jpg', 100, 80, 80);	
  129.                         </div>
  130.                     </dd>
  131.                     <dt>
  132.                         <span class="term">main::add_event(string module, string place)</span>
  133.                     </dt>
  134.                     <dd>
  135.                         <p>Добавляет новое событие модуля <strong class="command">$module</strong> в место <strong class="command">$place</strong>. Применяется в инсталляторе модуля.</p>
  136.                     </dd>
  137.                     <dt>
  138.                         <span class="term">main::delete_event(string module)</span>
  139.                     </dt>
  140.                     <dd>
  141.                         <p>Удаляет все события модуля <strong class="command">$module</strong>. Применяется в инсталляторе модуля при деинсталляции.</p>
  142.                     </dd>
  143.                 </dl>
  144.             </div>
  145.  
  146.             <div><br /><br /></div>
  147.  
  148.             <div class="navfooter"><hr />
  149.                 <table width="100%" summary="Navigation footer">
  150.                     <tr>
  151.                         <td width="40%" align="left"><a href="dev.general_functions.html">Пред</a></td>
  152.                         <td width="20%" align="center"><a href="index.html">На уровень выше</a></td>
  153.                         <td width="40%" align="right"><a href="dev.module_main.html">След</a></td>
  154.                     </tr>
  155.                     <tr>
  156.                         <td width="40%" align="left" valign="top">Главные методы ядра</td>
  157.                         <td width="20%" align="center">Содержание</td>
  158.                         <td width="40%" align="right" valign="top">Методы модуля main</td>
  159.                     </tr>
  160.                 </table>
  161.             </div>
  162.  
  163.         </body>
  164.     </html>