API

Материал из Booot

Шаблоны

tpl

Возвращает обработанный шаблон, $string — имя шаблона, $array — переменные шаблона ('var'=>'exam' → $var='exam')

tpl($string, $array);

Работа с базой данных

db()

Клонирует и отдает объект для работы с БД

db()
	-> query($query)		# Запрос к БД, $query — SQL-запрос
	-> fetch($result_type)		# Отдает текущую строку из результатов запроса, $result_type = MYSQL_BOTH [ MYSQL_ASSOC | MYSQL_NUM ]
	-> rows($query, $result_type)	# Отдает все содержимое запроса в массиве
	-> row_count()			# Число строк в результате запроса (только SELECT или SHOW)
	-> last_insert_id()		# Возвращает ID последней вставленной записи (INSERT)

$GLOBALS['data']

Надстройка над db(), используется для кэширования результатов запроса на время выполнения и простых выборок из одной таблицы

$GLOBALS['data']
	-> GetData($table, $where, $order)	# Отдает все данные из таблицы $table, 
						# также можно задать фильтр $where (например "AND `show` = 'Y'") и сортировку $order (например "`date` DESC")
						# данные возвращаются в виде массива с индексацией ключей по ID (Primary Key) записей
						# и по-умолчанию отсортированные по полю `order`, если оно существует
	-> GetDataById($table, $id)		# Возвращает одну запись по ее ID (Primary Key)
	-> SetStaticFilter($table, $where)	# Задает дополнительный фильтр $where на все выборки из таблицы $table

Системные функции

linkById

Возвращает ссылку по ID страницы, любой вложенности

linkById($id)

linkByModule

Возвращает ссылку по имени модуля, любой вложенности. Если модулей задано несколько, вернет ссылку только на один

linkByModule($module_name)

page404

Выводит страницу с 404 ошибкой

page404()

error

Выводит ошибку с текстом $error и указывает где она была вызвана

error($error)

giveObject

Отдает объект из глобальной области ($GLOBALS) по его имени. Если объект уже создан, отдает. Если нет, то создаст и отдаст.

giveObject($classname)

block

Возвращает содержимое блока (таблица blocks)

block($id, $return=false)

$id — id блока, может быть и строкой (поле callname в таблице blocks). $return — false отдает результат в поток вывода, true — возвращает как результат работы функции.

Дополнительные функции

goodDate

Нормальная, хорошая дата, например 23 февраля 2010

goodDate($dateStr)

$dateStr — Более или менее разборчивый формат даты, например из mysql (2010-02-23 12:10:05)

plural

Множественное число

plural($n, $str0, $str1, $str2)

$n — Число по которому будет считать существительные, например: $str0 = 'комментариев', $str1 = 'комментарий', $str2 = 'комментария'

debug

Удобный вывод массивов и другой отладочной информации

debug($data)

$data — данные в любом формате, обычно массив

jabber

Отправка сообщения любому пользователю в jabber аккаунт

jabber($to, $message)

$to — аккаунт пользователя, кому отправляем сообщение (andreydust@gmail.com), $message — текст сообщения (plain text)

Работа с изображениями

image

Пропорционально сжимает картинку по заданным размерам (максимальным), использует ImageMagick через системный вызов. Если изображение еще не обрабатывалось с указанными параметрами, создает его и возвращает адрес.

image($src, $width, $height, $format='png')

$src — адрес исходного изображения, $width — максимальная ширина сжатого изображения, $height — максимальная высота сжатого изображения, $format — формат сжатого изображения

imageLandscape

Сообщает, является ли изображение альбомным (ширина больше высоты)

imageLandscape($src)

$src — адрес изображения

img

Возвращает объект Images

img()

Images

Класс для работы с изображениями

API