PHP Splat Function

By  on  

One of my favorite MooTools functions is $splat(). Splat takes a given argument and returns an array if the argument is not already an array. This is especially helpful when I've coded my script to cycle through an array of items for processing one at a time.

The PHP Code

function splat($input) 
{
	return is_array($input) ? $input : array($input);
}

When do I use this? Lets say I have a list of items that I can delete individually or alternatively I can use checkboxes to select many to delete at once. Using splat() will ensure my code works if the user chooses to delete one item individually.

Recent Features

Incredible Demos

  • By
    MooTools Zebra Tables Plugin

    Tabular data can oftentimes be boring, but it doesn't need to look that way! With a small MooTools class, I can make tabular data extremely easy to read by implementing "zebra" tables -- tables with alternating row background colors. The CSS The above CSS is extremely basic.

  • By
    Save Web Form Content Using Control + S

    We've all used word processing applications like Microsoft Word and if there's one thing they've taught you it's that you need to save every few seconds in anticipation of the inevitable crash. WordPress has mimicked this functionality within their WYSIWYG editor and I use it...

Discussion

  1. Slick!

  2. splat()’s a pretty cool sounding function name, but I still prefer PHP’s explode().

  3. @Will: And the both deal with arrays!

  4. David,

    I see you writing (if) statements in a unique way that looks a lot cleaner…me being OCD I am really into this idea…can you explain more in depth the basics of writing an if statement this way…preferably an example of an if, else, and else if…that would be awesome.

    Thanks,
    Seth

  5. @Seth: Do a site search for “ternary.” That will get you all of my articles on the topic.

  6. You can also use typecasting:

    $a = (array) $b; instead of $a = splat($b);

  7. I agree with Bob and usually use typecasting for this sort of things.

    There are small differences, however. For example, if you pass an object into splat, you’ll get an object inside of the array. If you typecast an object, you will get an array containing the objects properties. That is one point to typecasting, in my opinion.

    Splat, on the other hand, handles null better. If you pass null into splat, you will get a null inside of the array. If you typecast a null, you will get an empty array. This is disappointing because this means there is no way to differentiate between $input being empty and $input being null.

    Keep in mind that if you typecast an array, you get the same array, not the same array inside another array.

    Therefore, you can get the best of both worlds with the following:

    function splat($input)
    {
    return is_null($input) ? array(null) : (array) $input;
    }

  8. Been working with forms a lot lately while I convert some of my flat php stuff to Ajax / Mootools. This is fantastic!

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!