# uname -a - Mot-clé - drupal

Drupal 8 / 9 / 10 : Programmatically render a view with contextual and exposed filters input

Mathieu — Sun, 10 Mar 2024 19:45:00 +0100

Exposed Input and Contextual Input are two different ways of providing input to Drupal Views.

Contextual filters work with an ordered list of parameters, while Exposed Input works with a form that has a couple name/value for every input parameter.

Contextual Filters

The right way to render a view result with contextual filters is to generate a render array:

$render_array = [
  '#type' => 'view',
  '#name' => 'YOUR_VIEW_NAME',
  '#display_id' => 'YOUR_VIEW_DISPLAY',
  '#arguments' => [CONTEXTUAL_FILTER_1, CONTEXTUAL_FILTER_2, ...],
];

You can then send the render array to a Twig variable, or render it programatically:

$result = \Drupal::service('renderer')->render($render_array);
return $result->__toString();

We are using the __toString() function to get the rendered HTML because the result returned by Drupal Render service is an object containing cache metadata.

Exposed Filters

The right way to render a view result with exposed filters is to generate a render array, and set the '#view#' parameter with a view object where you can initialize the filters:

$view = \Drupal\views\Views::getView('YOUR_VIEW_NAME');
$view->setExposedInput([
    'YOUR_FILTER_NAME' => 'YOUR_FILTER_VALUE',
]);
$render_array = [
  '#type' => 'view',
  '#name' => 'YOUR_VIEW_NAME',
  '#view' => $view,
  '#display_id' => 'YOUR_VIEW_DISPLAY',
  '#arguments' => [CONTEXTUAL_FILTER_1, CONTEXTUAL_FILTER_2, ...],
];

You can then send the render array to a Twig variable, or render it programatically:

$result = \Drupal::service('renderer')->render($render_array);
return $result->__toString();

We are using the __toString() function to get the rendered HTML because the result returned by Drupal Render service is an object containing cache metadata.

Leaked Metadata and Early Rendering

If you render a view while rendering a controller output that is suppose to provide its own cache metadata (CacheableJsonResponse for instance), and run on the error:

LogicException: The controller result claims to be providing relevant cache metadata, but leaked metadata was detected. Please ensure you are not rendering content too early.

Just wrap the rendering in a render context:

$context = new Drupal\Core\Render\RenderContext\RenderContext();
$html = \Drupal::service('renderer')->executeInRenderContext($context, function () {
  $render_array = [
    '#type' => 'view',
    '#name' => 'YOUR_VIEW_NAME',
    '#display_id' => 'YOUR_VIEW_DISPLAY',
    '#arguments' => [CONTEXTUAL_FILTER_1, CONTEXTUAL_FILTER_2, ...],
  ];
  $result = \Drupal::service('renderer')->render($render_array);
  return $result->__toString();
});

Sources

Drupal 8 : create a custom Rule Action

Mathieu — Wed, 27 Jul 2016 10:56:00 +0200

Warning : the Rule plugin for Drupal 8 was not considered stable when I wrote this post.

1. Drupal 8: the new modules paradigm

Drupal 8 modules structure changed, and many modules are now using the new API.

No more plain old functions name like hook_something, no more obscurous PHP for menu entries. Instead, Object Oriented programming, YAML configuration files, magic comments, and Symfony routing.

Let's give it a try, let's make our first simplest module.

2. Base module configuration

If you already know how to do this, jumb to next section.

Create a directory for your module, for instance mymodule.

Create an info file in YAML format : mymodule/mymodule.info.yaml:

name: 'My Module'
type: module
core: 8.x
package: Custom

You don't need more! You don't need routing as you will plug into Rules.

3. File names and Namespaces

Create the RulesAction directory and its parents: mymodule/src/Plugin/RulesAction/

Create a PHP file for your class: MyAction.php. The class will be loaded with the autoload system.

Edit the file you just created, and specify the namespace at the beginning of the file:

/**
 * @file
 * Contains \Drupal\mymodule\Plugin\RulesAction\MyAction.
 */
namespace Drupal\mymodule\Plugin\RulesAction;
use Drupal\rules\Core\RulesActionBase;

The namespace must correspond to your module name and class name!

4. Rule Action specifications and parameters

Comments are very important as they are also specifications. You will define your Action id, description, and parameters. For instance, here is a copied sample from the predefined action DataSet:

/**
 * Provides a 'My action' action.
 *
 * @RulesAction(
 *   id = "rules_myaction",
 *   label = @Translation("Set a data value"),
 *   category = @Translation("Data"),
 *   context = {
 *     "data" = @ContextDefinition("any",
 *       label = @Translation("Data"),
 *       description = @Translation("Specifies the data to be modified using a data selector, e.g. 'node:author:name'."),
 *       allow_null = TRUE,
 *       assignment_restriction = "selector"
 *     ),
 *     "value" = @ContextDefinition("any",
 *       label = @Translation("Value"),
 *       description = @Translation("The new value to set for the specified data."),
 *       default_value = NULL,
 *       required = FALSE
 *     )
 *   }
 * )
 */

The Rule id is rules_myaction.

The category of the action in the dropdown menu is Data and it will be labeled Set a data value.

The current action will have two parameters : the data that will be changed, and the corresponding value.

5. Rule Action callback

Again, no more plain callback, the function doExecute will be called to execute your Action:

class MyAction extends RulesActionBase {

  /**
   * Executes the Plugin.
   *
   * @param mixed $data
   *   Original value of an element which is being updated.
   * @param mixed $value
   *   A new value which is being set to an element identified by data selector.
   */
  protected function doExecute($data, $value) {
    $typed_data = $this->getContext('data')->getContextData();
    $typed_data->setValue($value);
  }

  /**
   * {@inheritdoc}
   */
  public function autoSaveContext() {
    // Saving is done at the root of the typed data tree, for example on the
    // entity level.
    $typed_data = $this->getContext('data')->getContextData();
    $root = $typed_data->getRoot();
    $value = $root->getValue();
    // Only save things that are objects and have a save() method.
    if (is_object($value) && method_exists($value, 'save')) {
      return ['data'];
    }
    return [];
  }

}

The class name has to correspond to your file name.

In this sample, the parameter $value will be set to $data.

6. Troubleshooting

Uncaught PHP Exception Drupal\\Component\\Plugin\\Exception\\PluginException: "Plugin (rules_myaction) instance class "Drupal\\tbh_system\\Plugin\\RulesAction\\MyAction" does not exist."

Your namespace/classname/filename/directoryname is probably wrong.

Source

Drupal 8 Rules Action documentation

About ToBeHost : the last of my student's projects

Mathieu — Thu, 01 Oct 2015 23:55:00 +0200

Hello there, this is not your ordinary reading on this blog. This post is a sort of introduction for a series of posts about the making of a free web hosting provider, implementing a web panel from scratch using Drupal for front-end and Puppet as back-end.

But first, let me introduce you the reason why we started the project. I said “we” because I am not the only one in the boat, but it’s me who will make all the technical choices, and implement it. I am also the one who was saying “give up” to my colleague a few months ago, before going back with this new and exciting crazy idea.

Genesis

ToBeHost is a project we started around 2008~2009. Before that, I was an active member at a free hosting provider (“Chez Mémé .net”). When this hosting provider closed, due to the lack of time from its founders, me and a friend I met on this hosting provider stated that we had both the technical and time resources to make our own hosting provider. It was just loaning a dedicated server and configuring all the stuff you need to have your site working. We were not experts (yet), but be were confident in the fact that we had the capacities to learn, and to make it working. This is also the moment where I started hacking on GNU/Linux

We tried several web panels. Between love and hate, we finally choose VHFFS. VHFFS is a great piece of software. For the kiddie I was, it was the sort of “perfect-even-scary” piece of Linux engineering. Because mass web hosting involves dealing with a lot of “subsystems” to make it work, what VHFFS was doing was simply amazing to me. Using libnss and nscd to make system user from a database was for me the cleverest way to make system users without having to deal with system commands. Using unix permissions and system users and groups instead of hacky chroots, safe_mode, and open_basedir was definitely feeling right to me. I learned a lot about Linux and Debian, and my first (and actually unique) contributed patch made me feel so proud of me.

The long love (and hate) story

Dealing with a single server, on a student time, was not complicated. When something went wrong, I was looking for the answer by myself because I was (and I am still) afraid of what people can think or say to me on a public IRC channel. We had some downtimes, and a few fears while restoring backups, but things were globally going well.

Some things were a little bit cumbersome, but I was thinking that it was part of the job. Re-compiling PureFTPD ans MySQL package at each upgrade was not actually a problem, because I was eager to learn how to patch, compile, and hack into Debian. I even rewrote the SQL queries when we upgraded to Debian Lenny, which was using libnss2.

The years passed, I was growing and becoming older (hey, don’t laugh). My years at university was taking much and much time over my “internet time”, as I was getting involved in the students’ association and my final exams were approaching. Finally, the project was in an informal standby, we decided that we had to close it, because we were both very busy elsewhere.

We officially closed. We sent the mail to users, I was ready to backup my configuration files and delete the data. We didn’t do it. Because of our sloppy feelings, and the fact that “it worked”, without “touching anything”. It was such a pity to let it go.

The last breath (or not)

Some months ago, we realized it had been several years that the project was officially dead. I didn’t stop hacking Linux. I had left my full-time job because I was working too much on projects I didn’t like (and some other reasons), and was running a freelance activity. My colleague was running a successful IT company with his associates, and we were working together on some professional projects (we still are).

New tools and software have appeared since my last glance to ToBeHost, and I also learned how to use new tools. I asked my colleague to let the project go, but we finally paid another month for the server.

And then, I thought: web hosting is actually what I am into at that time. I know how to do it the right way, with the smallest administration effort. None of the alternative panels was fitting as well as VHFFS for the work we wanted. Let’s take all the VHFFS goods (strictly unix permissions, not be afraid of user access to shell, trust user isolation and quota), and add some bullshit (PHP panel, made on top of a CMS), with a little bit of magic (Puppet automation). Let’s put it together, and see what is coming from it.

Voilà. This is how this project started.

Addendum

The project started, and it is pratically ready for beta-test. I will try to write that series of posts and explain how we made it, in order to inspire other people, and to help me keep my ideas clear.

As you may think, it is and it will be highly experimental. I don’t know if the growing of Puppet objects will be sustainable in the long term. I don’t know if Drupal will drive me crazy to the point I would rage delete my code. I don’t know if the whole project will be clean enough to release it opensource. But we will try.

Wanna join ?

Drupal 7 : create your own image effect for use in image styles

Mathieu — Wed, 25 Feb 2015 18:56:00 +0100

Drupal comes with many predefined effects, you can combine them in image styles to get the picture you want. But what if you have to make your own effect ? Here is how.

Step 1 : create a module

If you are a drupal developer, you should know how to make a module. Okay, I am lazy too :

myeffect.info :

name = My Effect
description = "My wonderful border effect"
core = 7.x
dependencies[] = image
files[] = myeffect.module
package = Media

Step 2 : declare your effect

Implement hook_image_effect_info :

function myeffect_image_effect_info() {
  $effects = array(
    'myeffect_image_border' => array(
      'label' => t('My Effect - Border'),
      'help' => t('Add border to an image'),
      'effect callback' => '_myeffect_image_border_effect',
// Let's make things simpler...
//      'form callback' => '_myeffect_image_border_form',
//      'summary theme' => '_myeffect_image_border_summary',
    ),
  );
  return $effects;
}

Step 3 : write the callback

function _myeffect_image_border_effect(&$image, $data) {
  if (!_myeffect_image_border($image, $data)) {
    watchdog('image', 'Image add border failed using the %toolkit toolkit on %path (%mimetype)', array(
      '%toolkit' => $image->toolkit,
      '%path' => $image->source,
      '%mimetype' => $image->info['mime_type'],
    ), WATCHDOG_ERROR);
    return FALSE;
  }
  return TRUE;
}

function _myeffect_image_border(stdClass $image, $data) {
  if ($image->toolkit == 'gd') {
    $params = array($image, $data);
    return call_user_func_array('_myeffect_gd_border', $params);
  } else {
    watchdog('image', 'The selected image handling toolkit %toolkit can not correctly process %function.', array(
      '%toolkit' => $image->toolkit,
      '%function' => $function,
    ), WATCHDOG_ERROR);
    return FALSE;
  }
}

Step 4 : make your effect !

function _myeffect_gd_border(stdClass $image, $data) {

  $width = $image->info['width'];
  $height = $image->info['height'];

  // Note : source image is in $image->resource
  $dst = imagecreatetruecolor($width, $height);

...

  // Update image object.
  $image->resource = $dst;
  $image->info['width'] = $width;
  $image->info['height'] = $height;

  return TRUE;
}

Source

The content of this article is widely based on the module Image Effect Kit, you can download and read it for a more complete example.

Drupal 7 : integrate a simple payment workflow with Payment module

Mathieu — Fri, 05 Dec 2014 15:00:00 +0100

Payment forms are common these days, and Drupal has already many out-of-the-box modules to implement a web shop.

But these modules are often very cumbersome, complicated, and not-so-easy to tweak for your own needs.

So, let’s (re)start from the beginning: let’s implement our own Payment form with Payment, and throw Ubercart, Commerce, and all his friends away.

Note that the use of Payment is compatible with Ubercart and Commerce, but please let me make it simpler.

Install Payment and Currency

Download and install Payment and Currency :

Or using Drush : drush dl payment currency

Don’t forget to enable your new modules Payment and Currency. Note that Payment has several submodules, I don’t need them for this example.

Download the payment method(s) you need

Payment only gives the workflow. Payment comes with several Payment methods available, that are implementing Payment API to hook into the workflow. The topic is integrting Payment, not writting a payment method, so you can choose whatever method(s) you want from the Payment project page.

In this example, I will use Paypal. So if you are still with me, download paypal_payment :

https://www.drupal.org/project/paypal_payment
or using drush : drush dl paypal_payment

PayPal Payment has several submodules, enable all available PayPal Payment submodules.

Create a module to set up the form

Inside the module, let’s make the form. Two solutions: either use the standalone form provided by the module to make a simple payment, or integrate the payment to your own existing form.

Using the standalone form

Using the standalone form is pretty straightforward, make a form builder callback function like this:

function _mycheckoutmodule_form($form, &$form_state, $nid) { $payment = new Payment(array( 'context_data' => array( // Add whatever you want in this array, this is passed to the payment method. If your are using Paypal Payment method, these informations are also POSTed to Paypal 'nid' => $nid, ), 'currency_code' => 'CHF', 'description' => t('Product description'), 'finish_callback' => '_mycheckoutmodule_payment_complete', // The function providing the page where the user is redirected after the payment )); $payment->setLineItem(new PaymentLineItem(array( 'amount' => 20, 'name' => t('Product name'), 'description' => t('Product description'), 'tax_rate' => '0.2', 'quantity' => 1, ))); $form = payment_form_standalone($form, $form_state, $payment); return $form; }

Integrate with your existing form

Again, simply change your form builder callback:

function _mycheckoutmodule_form($form, &$form_state, $node) { // My simple form only has 'email' item $form['email'] = array( '#type' => 'textfield', '#title' => t('Email'), '#required' => true, '#element_validate' => array('_mycheckoutmodule_email_element_validate'), // Please, implement this ); $payment = new Payment(array( 'context_data' => array( // Add whatever you want in this array, this is passed to the payment method. If you are using Paypal Payment method, these informations are also POSTed to Paypal 'nid' => $nid, ), 'currency_code' => 'CHF', 'description' => t('Product description'), 'finish_callback' => '_mycheckoutmodule_payment_complete', // The function giving the page wher ethe user is redirected ater the payment )); $payment->setLineItem(new PaymentLineItem(array( 'amount' => 20, 'name' => t('Product name'), 'description' => t('Product description'), 'tax_rate' => '0.2', 'quantity' => 1, ))); $form_info = payment_form_embedded($form_state, $payment); $form = array_merge($form, $form_info['elements']); // I have a specific #submit callback, so I have to add it, but if you don't have one, just skip theses lines $form['#submit'] = array_merge( array('mycheckoutmodule_form_submit'), $form_info['submit'], array('payment_form_standalone_submit') ); $form['submit'][] = array( '#type' => 'submit', '#value' => t('Buy now!'), ); $form['#validate'][] = 'mycheckoutmodule_form_validate'; // You should know how to implement this. return $form; }

Call your form and display it

I added a parameter to the form builder function, didn’t you notice ? Actually I am getting the NID of the product the user wants to purchase, so I pass it to the form builder function.

// Call the form builder $form_build = drupal_get_form('_mycheckoutmodule_form', $nid); $checkout_form = render($form_build); echo $checkout_form; // Or pass it to a theme

The “thank you for your purchase” page

The return page after the payment is handled by the function you specified while creating the Payment object.

If the user correctly gets back to the website (keep in mind it’s not always the case), you have access to the context data you passed to the Payment object, along with the Payment method return codes (given by the payment provider). You can use it to build your “thank you” page :

function _mycheckoutmodule_payment_complete($payment) { watchdog('mycheckoutmodule', '"Thank you" displayed for payment ' . $payment->pid . '.', array(), WATCHDOG_INFO); // Let's spam the logs if ($payment->statuses[count($payment->statuses)-1]->status == 'payment_status_success') { // Actually pretty bad, but statuses stacks in the stored Payment object drupal_set_message('Your payment has been received.', 'success'); drupal_goto('node/' . $payment->context_data['nid']); } else { drupal_set_message('Your payment is not yet validated, please wait.', 'warning'); drupal_goto('node/' . $payment->context_data['nid']); } }

Check if the Payment succeeded

IPN URL (for Paypal)

If you are using the Paypal payment method, you have to set up your Paypal account with the following URL : http://yoursite.com/paypal_payment_pps/return

The callback function

The IPN processing is abstracted by Payment module. Payment can provide you informations about current payment by using the Payment objects stored in Drupal’s database. So, process the payment when receiving the callback :

function _mycheckoutmodule_payment_status_changed($payment) { watchdog('mycheckoutmodule', 'Status for payment ' . $payment->pid . ' changed.', array(), WATCHDOG_INFO); // Let's spam the logs if ($payment->statuses[count($payment->statuses)-1]->status == 'payment_status_success') { watchdog('mycheckoutmodule', 'Status for payment ' . $payment->pid . ' detected completed.', array(), WATCHDOG_INFO); // spam, spam! _mycheckoutmodule_process_delivery($payment->context_data['nid']); // You should implement this to do something once the payment is received }; }

You can have a list of the available statuses in the file sites/all/modules/contrib/payment/payment/payment.payment.inc

The callback Rule

I didn’t find how to get the callback function triggering using an hook to Payment API. But Payment provides Rules conditions to handle the callbacks, let’s use it.

You can programmatically add a rule to your module, but if you are a lazy man like me, just add it from Rules UI : define a condition “payment status changed” and action “execute PHP” to call your function :

_mycheckoutmodule_payment_status_changed($payment);

Known bugs

There are some cutting edge while using this module : I didn’t succeeded at having the price rounded while using the “tax” argument. As a walkaround, you can just skip the “tax” argument of the form, or set it to 0. You need a simple form, so you maybe you don’t bother about dislaying the tax rate or not.

Drupal 7 : change page title on node form

Mathieu — Mon, 10 Nov 2014 11:19:00 +0100

Every rule has its exceptions, setting drupal_set_title directly on form_alter doesn’t work for node form title. To customize pages like “Add node”, or “Edit node” :

Make a module
Add a function to implement hook_form_alter
Add a form afterbuild in your hook_form_alter implementation: $form['#after_build'][] = '_my_callback_form_set_title'
In '_my_callback_form_set_title', use drupal_set_title to change the form title: drupal_set_title(...)
Update system table to have the weight of your module greater than Node module (on a default install, core modules are weighted 0, so set your module weight to 1).
Rebuild registry, clear caches.