inst::blog

PHPcURL

Mon, 10 Jan 2011 12:46:00 PST

Пару дней назад написал я для собственных нужд объектно-ориентированную обёртку для расширения cURL, используя PHP. Показалось, что вещь получилась относительно удобная, ибо очевидно, объектная ориентированность в данном подходе вовсе не избыточна, так что решил поделиться исходным кодом с миром. Код выложил на GitHub'е. Там же, как смог, написал документацию на английском, поэтому если найдёте ошибки — не стесняйтесь мне на них указывать. Ссылка на репозитарий и английскую версию документации в конце поста, а немного ниже я хотел бы привести русский вариант краткой её части.

Краткие примеры

Использование класса довольно примитивно, достаточно включения в проект одного-единственного файла cURL.class.php, например так:

include_once dirname( __FILE__ ) . DIRECTORY_SEPARATOR . 'classes'
        . DIRECTORY_SEPARATOR . 'cURL.class.php'

Предполагается, что вы храните используемые классы в подпапке classes.

Использование

Начинать использовать класс можно сразу после включения файла, после этого просто создайте новый экземпляр класса и используйте его для выполнения необходимых запросов.

try
 {
    $curl = new cURL;
    if ( $curl->init( 'http://www.example.org/' ) ) $curl->exec();
 } catch( cURLException $e ) {
    // cURL is not installed
    print_r( $e->getMessage() );
 }

Этот пример после запуска просто выведет на экран пользователя содержимое www.example.org

Как видите, мы инициировали одну сессию, однако не закрыли её: в этом нам помогли деструкторы — одна из прелестей ООП.

Примеры подлинее

Рано или поздно у вас появится необходимость работать с параметрами cURL, для того, чтобы управлять ходом выполнения вашего сценария. В этом случае вам пригодится любой из трёх возможных способов:

Конструктор класса: здесь можно указать так называемые опции по умолчанию, с которым будет инициироваться каждая новая сессия. Кроме того, только в конструкторе можно указать опцию retry, т.е. после создания экземпляра класса её невозможно переназначить. Эта опция отвечает за количество повторений запроса до того, как функция exec() зафиксирует серверную ошибку.
Функция init( $url, array( option => value ) ); второй параметр которой может, в том числе, и переназначать опции, назначенные в конструкторе.
Либо, может быть полезным изменить некоторые опции уже инициированной сессии. Для этого используются функции set_option( option, $value [, $n] ) ); и set_options( array( option => value );

try
 {
    $curl = new cURL( array(
        'retry'                 => 3,
        CURLOPT_USERAGENT       => 'Mozilla/5.0 PHP cURL agent',
        CURLOPT_RETURNTRANSFER  => TRUE
    ) );
    $curl->init( 'http://www.inst.tk/' );
    $curl->init( 'http://twitter.com/', array( 'somewrongkey' => 'somewrongvalue' ) );
    $curl->init( 'http://www.google.com/', array( CURLOPT_FOLLOWLOCATION => TRUE ) );
    $curl->exec();
    var_dump( $curl->info() );
    $curl->clear();
    $curl->init( array( 'http://www.google.com/', 'www.yahoo.com', 'http://www.flickr.com/' ) );
    $curl->exec();
    var_dump( $curl->info() );
 } catch( cURLException $e ) {
    print_r( $e->getMessage() );
 } catch( RuntimeException $e ) {
    print_r( $e->getMessage() );
 } catch( Exception $e ) {
    print_r( $e->getMessage() );
 }

Запомните, при инициализации нескольких передач данных класс попробует выполнить их в режиме multithread.

Давайте немного обсудим приведённый выше пример, чтобы в деталях понять, как он работает. Во-первых, мы создаём новый экземпляр класса. Как уже говорилось ранее, в конструкторе можно указывать опции по умолчанию, которые будут применены к каждой передаче — этим мы и воспользовались, так что теперь все наши передачу, например, будут передавать уникальный Useragent. Во-вторых, мы попытались инициировать три разные сессии передачи, однако вторая не будет выполнена, так как содержит неверные параметры. В-третьих, после выполнения созданных сессий мы собираем информацию о ходе их выполнения. Вызвав метод clear() мы как бы забываем обо всех созданных раньше сессиях (так что не пытайтесь после этого получить о них какую бы то ни было информацию), но помня об особенности конструктора мы не удаляем сам объект.

Как вы уже наверно поняли, после очистки мы снова создаём новые сессии передачи, но на этот раз уже используем другую фичу нашего класса: массив URL.

Ещё одна фича, о которой вы вероятно уже догадались, благодаря этому классу нам нет необходимости во время инициализации сессии указывать протокол. Если класс заметит, что в нашем URL не хватает двоеточия и двух слешей, он автоматически будет рассматривать его как запрос к HTTP-серверу.

Последняя вещь, на которой стоит остановиться поподробнее — это исключения. Для уверенной работы с классом достаточно отлавливать всего три типа исключений:

cURLException: на сегодня эта штука бросается только если на сервере не установлено расширение cURL.
RuntimeException: бросается только из multithread-кода. cURLException является подмножеством RuntimeException.
DomainException: его бросает только set_options().

IMHO, рассмотренного достаточно для выполнения большинства задач. Тех, кому интересно, как устроен класс более подробно милости прошу на страницу наиболее подробной документации. Кроме того, исходный код ни от кого не скрыт.

Ну а в самом конце хотелось бы сказать, что с удовольствием постараюсь ответить на ваши вопросы и мне не остаётся ничего кроме как дать обещанные в начале поста ссылки:
Документация [eng]
Ссылка на репозитарий

текст	текст	текст полностью	текст полностью
:)	:-)	:smile:	:lol:
:D	:-D	:grin:	:oops:
:(	:-(	:sad:	:cry:
:o	:-o	:eek:	:evil:
8O	8-O	:shock:	:twisted:
:?	:-?	:???:	:roll:
8)	8-)	:cool:	:!:
:x	:-x	:mad:	:?:
:P	:-P	:razz:	:idea:
:\|	:-\|	:neutral:	:arrow:
;)	;-)	:wink:	:mrgreen:

inst::blog

PHPcURL

Краткие примеры

Использование

Примеры подлинее

Получение изображений из Google Picasa API на PHP

MySQL, PostgreSQL и SQLite3: вставка случайной строки

IT-шники о девушках

Насыщенная зима

Как скачать видео с YouTube

Интерполяция функции

Массив на чистом Си

Работа с SQLite3 в PHP5

GTK+ на русском языке

Идентификаторы городов в Gismeteo

POST и GET в Apache и .htaccess

Смайлы в WordPress: пользуемся колобками

Создание и удаление папок в Ruby

Список ping-сервисов

Получение IP посетителя сайта

Как начинается зароботок

Пара слов о жизни сайта

Поиск по умолчанию в Firefox 3.5

Привет!