PHP-NetPBM Manual

Список функций класса:

Описание функций класса:


function create_macro ( $input_file_type, $output_file_name, $output_file_type )

Назначение: Создаёт макро класс, в который можно добавлять любое количество операций.
Принимаемые параметры:
  1. $input_file_type - маска входных файлов
  2. $output_file_name - маска конечных файлов
  3. $output_file_type - желаемый конечный формат
Возвращяет: указатель на сам макро.

пример :
<?
	include ( "NetPBM.class.php" );
	$NetPBM=new NetPBM_Library();
--->	$flip=$NetPBM->create_macro ( "*","*_fliped","jpg" );
	$NetPBM->export_macro ( $flip,"pnm","flip","-r90" );
	$NetPBM->perform_macro ( $flip,"../images/" );
?>






function export_macro ( &$macro, $pbm_format, $action )

Назначение: Принимает как параметер макро класс, добавляет требуемую команду в список команд к выполнению. В случае отсутствия конвертера или трансформатора сообщяет об этом, даже не находясь в режиме отладки.
Принимаемые параметры:
  1. &$macro - указатель на макро обьект
  2. $pbm_format - желаемый формат трансформации ( мануалах о NetPBM - тема PBM форматы )
    принимает значения : "pnm"/"ppm"/"pgm"/"pbm"
  3. $action - желаемая трансформация и параметры. Параметры описанны в отдельном htm файле, по имени трансформатора.
Возвращяет: ничего.

пример :
<?
	include ( "NetPBM.class.php" );
	$NetPBM=new NetPBM_Library();
	$flip=$NetPBM->create_macro ( "*","*_fliped","jpg" );
--->	$NetPBM->export_macro ( $flip,"pnm","flip","-r90" );
	$NetPBM->perform_macro ( $flip,"../images/" );
?>






function perform_macro ( &$macro, $input )

Назначение: Производит макро команды над переданными файлом или дирректорией. В случае дирректории - поиск файлов в ней происходит по маске заданной при создании макро, все вложенные дирректории будут просмотренны в рекурсивном виде. Выходные файлы будут сохраненны в заданном формате и дирректории. Если дирректория не указанна - будут сохранятся рядом с входными файлами. Если маска имени выходных и входных файлов совпадает - исходные файлы будут замененны на трансформированные. Каждая трансформация кешируется, в случае повторной трансформации, сверяется размер, дата создания, путь к файлам, порядок конвертаций и в случае совпадения конвертации не происходит, что серьёзно влияет на скорость выполнения всего макро в лучшую сторону. Опцию кеширования можно отключить в любой момент.
Принимаемые параметры:
  1. &$macro - указатель на макро обьект
  2. $input - входные файл или дирретория
Возвращяет: ничего.

пример :
<?
	include ( "NetPBM.class.php" );
	$NetPBM=new NetPBM_Library();
	$flip=$NetPBM->create_macro ( "*","*_fliped","jpg" );
	$NetPBM->export_macro ( $flip,"pnm","flip","-r90" );
--->	$NetPBM->perform_macro ( $flip,"../images/" );
?>






function get_affected_files ( &$macro )

Назначение: Получение списка файлов, обработанных макросом.
Принимаемые параметры: нету.
Возвращяет: массив, каждый элемент которого содержит хеш массив для каждого выполнения комманд над файлами:
пример :
<?
	include ( "NetPBM.class.php" );
	$NetPBM=new NetPBM_Library();
	$flip=$NetPBM->create_macro ( "*","*_fliped","jpg" );
	$NetPBM->export_macro ( $flip,"pnm","flip","-r90" );
	$NetPBM->perform_macro ( $flip,"../images/" );
--->	$source=$flip->get_affected_files();
	print_r ($source);
?>






function get_debug_mode()

Назначение: Выяснение состояния флага отладки.
Принимаемые параметры: нет.
Возвращяет: правда/неправда.

пример :
<?
	include ( "NetPBM.class.php" );
	$NetPBM=new NetPBM_Library();
	$flip=$NetPBM->create_macro ( "*","*_fliped","jpg" );
	$NetPBM->export_macro ( $flip,"pnm","flip","-r90" );
	$NetPBM->perform_macro ( $flip,"../images/" );
--->	if ( $NetPBM->get_debug_mode() )
		print "debugging";
	else	print "clean execution only";
?>






function set_debug_mode()

Назначение: Изменение флага отладки. При состоянии включенно - все выполянемые команды будут отображенны непосредственно перед выполнением, результаты будут так-же отображенны в браузере.
Принимаемые параметры: правда/неправда.
Возвращяет: ничего

пример :
<?
	include ( "NetPBM.class.php" );
	$NetPBM=new NetPBM_Library();
--->	$NetPBM->set_debug_mode ( 1 );
	$flip=$NetPBM->create_macro ( "*","*_fliped","jpg" );
	$NetPBM->export_macro ( $flip,"pnm","flip","-r90" );
	$NetPBM->perform_macro ( $flip,"../images/" );
?>






function get_image_info ( $file )

Назначение: Выяснение информации о файле-картинке.
Принимаемые параметры: путь к файлу-картинке.
Возвращяет: стандартный массив, где поля от 0 до 5 содержат
  1. ширина картинки
  2. высота картинки
  3. формат картинки
  4. готовая к вставке непосредственно в htm строка, содержащая высоту и ширину картинки
    ( width="120" height="80" )
  5. размер файла-картинки в байтах
  6. готовая к вставке строка содержащая размер картинки, и время скачивания на модеме в 56,600 боунд.
    ( alt="89,388b, 0:0.12 @ 56,600kbps" )

пример :
<?
	include ( "NetPBM.class.php" );
	$NetPBM=new NetPBM_Library();
	$flip=$NetPBM->create_macro ( "*","*_fliped","jpg" );
	$NetPBM->export_macro ( $flip,"pnm","flip","-r90" );
	$NetPBM->perform_macro ( $flip,"../images/" );
--->	$source=$NetPBM->get_image_info ( "../images/logo.gif" );
	print_r ( $source );
?>






function info()

Назначение: Выяснение сведений о системе. будет отображенна страница подобная phpinfo(); содержащая все сведения о системе, все конвертеры и трансформаторы. Настройки кеширования и пути к выполняемым файлам.
Принимаемые параметры: нету.
Возвращяет: ничего

пример :
<?
	include ( "NetPBM.class.php" );
	$NetPBM=new NetPBM_Library();
--->	$NetPBM->info();
?>