Мощные пользовательские объекты с PHP-клиентом Diffbot

Нам нужны два новых класса: фабрика сущностей и сущность. Давайте создадим их в /src/AuthorFolio.php и src/CustomFactory.php относительно корня нашего проекта ( src находится в корневой папке).

AuthorFolio

Давайте начнем с новой сущности. Согласно документации , у нас есть абстрактный класс, который мы можем расширить.

 <? php // src/AuthorFolio.php 

 namespace   My \Custom ; 

 use   Swader \Diffbot\Abstracts\Entity ; 

 class   AuthorFolio   extends   Entity 
 { 

 } 

Мы расширяем абстрактную сущность и даем нашей новой сущности свое собственное пространство имен. Это необязательно, но полезно. На этом этапе объект уже можно было бы использовать — он по существу идентичен объекту с подстановочными знаками, который использует магические методы для разрешения запросов на различные свойства возвращаемых данных (именно поэтому метод getBio в приведенном выше примере работал без необходимости определять что-нибудь). Но цель состоит в том, чтобы получить подробный класс AuthorFolio с поддержкой пользовательских, специфичных для SitePoint данных и, возможно, некоторых быстрых методов. Давайте сделаем это сейчас.

API вернет полный список статей автора, но не их количество. Чтобы узнать, сколько постов имеет автор, нам нужно count свойство article, поэтому давайте обернем этот процесс в ярлык. Мы также можем сообщить PHPStorm, что у класса будет свойство article, использующее тег @property , поэтому он перестает жаловаться на доступ к полю магическими методами:

 <? php // src/AuthorFolio.php 

 namespace   My \Custom ; 

 use   Swader \Diffbot\Abstracts\Entity ; 

 /** * Class AuthorFolio * @property array articles * @package My\Custom */ 
 class   AuthorFolio   extends   Entity 
 { 
     public   function  getType () 
     { 
         return   'authorfolio' ; 
     } 

     public   function  getNumPosts () 
     { 
         return  count ( $this -> articles ); 
     } 
 } 

Другими методами, которые мы могли бы определить, являются totalLikes , activeSince , favoredCategory и т. Д.

CustomFactory

Когда сущность готова, пришло время определить собственную фабрику, чтобы связать ее с типом возвращаемых данных, которые мы получаем из нашего пользовательского API. Мы пишем альтернативу фабрике по умолчанию , но оригинальный класс уже содержит некоторые методы, которые мы можем использовать — он предназначен для повторного использования его дочерними элементами. Таким образом, нам просто нужно расширить оригинал, сопоставить новый тип с нашей пользовательской сущностью, и все готово.

 <? php // src/CustomFactory.php 

 namespace   My \Custom ; 

 use   Swader \Diffbot\Factory\Entity ; 

 class   CustomFactory   extends   Entity 
 { 
     public   function  __construct () 
     { $this -> apiEntities =  array_merge ( $this -> apiEntities , 
             [ 'diffpoint'   =>   '\My\Custom\AuthorFolio' ] 
         ); 
     } 
 } 

Мы объединили исходный список API-сущностей с нашей собственной пользовательской привязкой, тем самым сказав классу Factory, чтобы он следил как за стандартными типами и API, так и за нашими новыми. Это означает, что мы можем продолжать использовать эту фабрику для API-интерфейсов Diffbot по умолчанию.

Подключить фабрику

Чтобы сделать наши классы автоматически загружаемыми, мы, вероятно, должны добавить их в composer.json :

    "autoload" :   { 
     "psr-4" :   { 
       "My\\Custom\\" :   "src" 
     } 
   } 

Мы активируем эти новые сопоставления автозагрузки, запустив composer dump-autoload .

Далее мы создаем новую фабрику, подключаем ее к нашему экземпляру Diffbot и тестируем API:

 $d =   new   Diffbot ( TOKEN ); $d -> setEntityFactory ( new   My \Custom\CustomFactory ()); $api =  $d -> createCustomAPI ( 'http://www.sitepoint.com/author/bskvorc' ,   'diffpoint' ); $api -> setTimeout ( 120000 ); $result =  $api -> call (); 

 dump ( $result -> getNumPosts ()); 

Обратите внимание, что мы увеличили время ожидания, потому что рендеринг в конце Diffbot сильно постраничный набор постов может занять некоторое время.

Вывод

В этом руководстве с помощью официального клиента Diffbot мы создали собственные объекты и создали специальный API, который их возвращает. Мы увидели, как легко использовать машинное обучение и оптическую обработку контента для получения произвольных данных с веб-сайтов любого типа, и мы увидели, насколько сильно настраивается клиент Diffbot.

Хотя это был довольно простой пример, нетрудно представить сложные варианты использования для более сложных сущностей, или, возможно, несколько из них распределены по нескольким API, причем все они обрабатываются одним EntityFactory, причем каждый пользовательский API соответствует особому типу Entity. С хорошо обученной визуальной нейронной сетью единственным пределом обработки является воображение.

Если вы хотите узнать больше о клиенте Diffbot, ознакомьтесь с полной документацией и поэкспериментируйте с самим собой — просто не забудьте получить свежий бесплатный двухнедельный демо-токен!