What I have:
I want to use an external API and display the results on the page.
- To that end, I created a custom route that is attached to the controller with a custom twig design.
- When you visit this route, load the function in the controller onto the external API, call up the data and pass this data in array form to the custom Twig template.
- Since the external API also offers a search function, we created a form and added this form with the Drupal form generator and also sent this form over the data in the array. With Twig this search form is attached to and above the search results table.
- Now I want to add a pagination under the Twig results table with the buttons for the next page and the previous page. The pagination functionality is provided by the API itself, and the links to the new and previous page are given in the API response itself. With Ajax callback, I'm trying to update my data and resend to the Twig template, but it doesn't work.
What I created for pagination:
- The Controller Form Builder creates a new form without a route and adds it to the Twig template.
- I pass the URL of the next page and the URL of the previous page as parameters to the form.
- This parameter is used in the build form function.
- I appended the URL of the next and previous page with custom arguments to the form elements.
Now when you click the next button, the new data is loaded via an Ajax call attached to the button for the next page in the form, and the twig table is updated with data for page 2. When the next button is clicked again, the same URL is called again even after the field arguments in the Ajax callback have been updated.
If my approach is wrong, please let me know that I am ready to correct my approach.
MyController.php
/**
* @file
* Contains Drupaldtn_feedControllerAPFeedListController.
*/
namespace Drupaldtn_feedController;
use DrupalCoreControllerControllerBase;
use DrupalComponentSerializationJson;
use DrupalCoreLoggerLoggerChannelFactory;
use DrupalCoreMessengerMessengerInterface;
use Drupaldtn_feedSearchAndFeedHandler;
use SymfonyComponentDependencyInjectionContainerInterface;
/**
* Returns responses for Quick Node Clone Node routes.
*/
class APFeedListController extends ControllerBase {
/**
* @var searchFeedHandler
* Variable used for loading search feed handler service.
*/
protected $searchFeedHandler;
/**
* @var url
* Variable used to store $url.
*/
protected $url;
/**
* @var next_page_url
* Variable used to hold next page url
*/
protected $next_page_url;
/**
* @var previous_page_url
* Variable used to hold previous page url
*/
protected $previous_page_url;
/**
* Constructs a NodeController object.
*
* @param DrupalCoreLoggerLoggerChannelFactory $logger_factory
* Passing an Instance of logger factory.
* @param DrupalCoreMessengerMessengerInterface $messenger
* The messenger service.
* @param Drupaldtn_feedSearchAndFeedHandler $search_feed_handler
* The search feed handler custom service.
*/
public function __construct(LoggerChannelFactory $logger_factory, MessengerInterface $messenger, SearchAndFeedHandler $search_feed_handler)
{
$this->loggerFactory = $logger_factory;
$this->messenger = $messenger;
$this->searchFeedHandler = $search_feed_handler;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container)
{
return new static(
$container->get('logger.factory'),
$container->get('messenger'),
$container->get('dtn_feed.feed.feed_api_handler')
);
}
/**
* Create Feed Url.
*
* @return string
*/
private function getFeedUrl() {
$urlParams = 'search?q=';
$url = $this->searchFeedHandler->generateUrl($urlParams);
return $url;
}
/**
* Lists Feeds.
*
* @return array
*/
public function listFeeds() {
$url = $this->getFeedUrl();
$jsonFeedData = $this->searchFeedHandler->getApFeeds($url);
$decodedJsonFeedData = Json::decode($jsonFeedData);
$searchForm = $this->formBuilder()->getForm('Drupaldtn_feedFormApFeedsSearchForm');
if (isset($decodedJsonFeedData('data')('next_page'))) {
$items('next_page') = $decodedJsonFeedData('data')('next_page');
$this->next_page_url = $decodedJsonFeedData('data')('next_page');
}
$items('current_page') = $decodedJsonFeedData('data')('current_page');
if (isset($decodedJsonFeedData('data')('previous_page'))) {
$items('previous_page') = $decodedJsonFeedData('data')('previous_page');
$this->previous_page_url = $decodedJsonFeedData('data')('previous_page');
}
$paginationForm = $this->formBuilder()->getForm('Drupaldtn_feedFormApFeedsPaginationForm', $items);
return (
'#theme' => 'dtn_feed_apFeeds_list',
'#search_form' => $searchForm,
'#feedsList' => $decodedJsonFeedData,
'#pagination_form' => $paginationForm,
);
}
/**
* Reads the data from the json file.
*
* @return array
* jsonData
*/
public function readJsonData() {
$currentDirectory = drupal_get_path('module', 'dtn_feed');
$path = $currentDirectory . '/ApJsonData/ApData.json';
$data = file_get_contents($path);
return $data;
}
}
My form.php
namespace Drupaldtn_feedForm;
use DrupalComponentSerializationJson;
use DrupalCoreFormFormBase;
use DrupalCoreFormFormStateInterface;
use Drupaldtn_feedSearchAndFeedHandler;
use SymfonyComponentDependencyInjectionContainerInterface;
use DrupalCoreConfigConfigFactoryInterface;
use DrupalCoreFormFormBuilderInterface;
use DrupalCoreAjaxAjaxResponse;
use DrupalCoreAjaxReplaceCommand;
/**
* Provide a search form for search AP Feed.
*/
class ApFeedsPaginationForm extends FormBase {
/**
* @var SearchAndFeedHandler $feed_api_handler
*/
protected $feed_api_handler;
/**
* @var configFactoryInterface
*/
protected $config_factory;
/**
* @var FormBuilderInterface
*/
protected $form_builder;
/**
* Class constructor.
* @param SearchAndFeedHandler $feed_api_handler
*/
public function __construct(SearchAndFeedHandler $feed_api_handler, ConfigFactoryInterface $configFactory, FormBuilderInterface $formBuilder)
{
$this->feed_api_handler = $feed_api_handler;
$this->config_factory = $configFactory;
$this->form_builder = $formBuilder;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container)
{
return new static(
$container->get('dtn_feed.feed.feed_api_handler'),
$container->get('config.factory'),
$container->get('form_builder')
);
}
/**
* {{ @inheritDoc }}
*/
public function getFormId()
{
return 'dtn_feed_ap_feed_pagination_form';
}
/**
* {{ @inheritDoc }}
*/
public function buildForm(array $form, FormStateInterface $form_state, $items = ()) {
$form('#theme') = 'dtn_feed_pagination_form';
$form('pagination') = (
'#type' => 'fieldset',
'#title' => $items('next_page'),
'#open' => TRUE,
);
$form('pagination')('previous') = (
'#type' => 'button',
'#value' => t('Previous'),
'#attributes' => (
'disabled' => 'disabled'
),
);
$form('pagination')('next') = (
'#type' => 'button',
'#value' => $this->t("Next"),
'#attributes' => (
'#args' => $items('next_page'),
// 'disabled' => 'disabled'
// 'id' => "next-page"
),
'#ajax' => (
'callback' => '::getApNewsSearchResult',
'event' => 'click',
'wrapper' => 'ap-news-table-list',
'progress' => (
'type' => 'throbber',
'message' => $this->t('Getting news for you...'),
),
),
);
return $form;
}
/**
* {{ @inheritDoc }}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$form_state->setRebuild(TRUE);
$form_state->setCached(FALSE);
// @todo Needs to decide what is to be done upon form submission.
}
/**
* Get Search result from Ap News.
* @param array $form
* @param FormStateInterface $form_state
* @return mixed
*/
public function getApNewsSearchResult(array &$form, FormStateInterface &$form_state) {
$config = $this->config_factory->getEditable('dtn_feed.ap_feed_conf');
$api_key = $config->get('ap_feed_key');
$url = $form('pagination')('next')('#attributes')('#args') . '&apikey=' . $api_key;
$resultJson = $this->feed_api_handler->getJsonBodyFromAp($url);
$decodedJsonData = JSON::decode($resultJson);
if (isset($decodedJsonData('data')('next_page'))) {
$items('next_page') = $decodedJsonData('data')('next_page');
}
$items('current_page') = $decodedJsonData('data')('current_page');
if (isset($decodedJsonData('data')('previous_page'))) {
$items('previous_page') = $decodedJsonData('data')('previous_page');
};
$form('pagination')('next')('#attributes')('#args') = $items('next_page');
$url = $form('pagination')('next')('#attributes')('#args');
$form('pagination')('#title') = $url;
return (
"#theme" => 'dtn_feed_apFeeds_list',
"#feedsList" => $decodedJsonData,
'#pagination_form' => $form,
);
}
}
