Contrib.social

Add helper methods to inject items into a particular position in associative arrays

Open on Drupal.org →
Created on 30 May 2006, over 18 years ago
Updated 6 September 2024, 5 months ago

Problem/Motivation

One of the most difficult things about manipulating Drupal forms is the process of manipulating the arrays themselves. And one of the things that I commonly want to do is "stick this stuff in after that". But I have yet to find a PHP function to manipulate arrays in this way.

So I wrote this function called array_insert(). Perhaps there's a cleaner way to handle this, but it seems like a function that should be available in Drupal core. It would certainly help with a lot of common hook_form_alter() tasks.

For instance, this function (finally) offers a way to stick something into the node-type settings page (admin/settings/content-types/[node-type]) immediately before the "submit" buttons, you'd just create an array with your form items and then call

$form = array_insert($form, 'buttons', $my_stuff, TRUE);

/**
 * Inserts values from $arr2 after (or before) $key in $arr1
 * if $key is not found, $arr2 is appended to $arr1 using array_merge()
 *
 * @param $arr1
 *   array to insert into
 * @param $key
 *   key of $arr1 to insert after
 * @param $arr2
 *   array whose values should be inserted
 * @param $before
 *   insert before the given key. defaults to inserting after
 * @return
 *   merged array
 */
function array_insert($arr1, $key, $arr2, $before = FALSE){
  $done = FALSE;
  foreach($arr1 as $arr1_key => $arr1_val){
    if(!$before){
      $new_array[$arr1_key] = $arr1_val;
    }
    if($arr1_key == $key && !$done){
      foreach($arr2 as $arr2_key => $arr2_val){
        $new_array[$arr2_key] = $arr2_val;
      }
      $done = TRUE;
    }
    if($before){
      $new_array[$arr1_key] = $arr1_val;
    }
  }
  if(!$done){
    $new_array = array_merge($arr1, $arr2);
  }
  return $new_array;
}

Steps to reproduce

N/A

Proposed resolution

Introduce new utility class for addressing the problem.

Remaining tasks

Review
Commit

User interface changes

N/A

Introduced terminology

N/A

API changes

N/A

Data model changes

N/A

Release notes snippet

N/A

✨ Feature request
Status

RTBC

Version

11.0 🔥

Component
Base  →

Last updated about 2 hours ago

Created by

🇺🇸United States jjeff

Live updates comments and jobs are added and updated live.
  • API addition

    Enhances an existing API or introduces a new subsystem. Depending on the size and impact, possibly backportable to earlier major versions.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Comment 6 months ago →
    🇬🇧United Kingdom joachim

    > To fix it, we can replace the array_merge() with the array addition operator:

    That didn't quite do it!

    We also need to pass preserve_keys: TRUE to the calls to array_slice().

    Fixed, and added test coverage.

  • Status changed to Needs review 6 months ago
  • @joachim opened merge request.
  • Comment 6 months ago →
    🇺🇸United States smustgrave

    Mostly small stuff

  • Status changed to Needs work 6 months ago
  • Comment 6 months ago →
    🇺🇸United States smustgrave

    Also definitely think worth a change record to announce such a helper

  • Status changed to Needs review 6 months ago
  • Comment 6 months ago →
    🇬🇧United Kingdom joachim

    All changes made and CR written.

  • Status changed to RTBC 6 months ago
  • Comment 6 months ago →
    🇺🇸United States smustgrave

    CR looks good. Thanks for including an example I personally find those always welcome and useful.

    All feedback on MR addressed and appears functional.

  • Comment 6 months ago →
    🇬🇧United Kingdom joachim

    Fixed a docs error I only just spotted!

  • Issue was unassigned.
  • Comment 5 months ago →
    🇫🇷France nod_ Lille

    Shouldn't the methods be named InsertArray::before and InsertArray::after?

  • Comment 4 months ago →
    🇳🇿New Zealand quietone

    Needs work to discussion the suggestion in #115, which I also support.

    What are the uses cases for this in core?

  • Comment 4 months ago →
    🇬🇧United Kingdom joachim

    There's an array_splice() in locale_form_language_admin_overview_form_alter() that looks like a good candidate.

    Also editor_form_filter_admin_overview_alter().

    And #1876718: Allow modules to inject columns into tables more easily → which is mentioned in a code comment there might have more examples and should possibly be marked as related to this issue.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024