Learning ColdFusion 9: Delete Array Elements With ArrayDelete()

A little while ago, I blogged about ColdFusion 9's new ArrayFind() and ArrayContains() methods. ColdFusion 9 also has a similar method for deleting elements from an array: ArrayDelete(). Like ArrayFind() and ArrayContains(), ArrayDelete() takes an array and a target value to delete (rather than a target index as is used in ArrayDeleteAt()). To explore this, I set up a simple demo:

Here, we are building an array of values and then deleting one of them. Notice that the value that we are deleting, "Sarah," appears multiple times within the original array. After we call ArrayDelete() on the array with the target value, "Sarah," we get the following CFDump output:

Notice that only one of the three instances of "Sarah" were removed from the array. As it turns out, ArrayDelete() only deletes the first instance that it finds, leaving the last two intact.

Since both ArrayFind() and ArrayContains() work with complex values, I assumed that ArrayDelete() would as well; but, rather than assuming now and being wrong later, I figured I should run at least one test with complex data:

Here, you can see rather than having simple girl names, I am creating complex girl objects. And, rather than passing in a simple name to the ArrayDelete() function, I am passing in a struct. When we run this code, we get the expected CFDump output:

Just as we would expect based on the first example, only the first instance of the Sarah girl object was deleted.

But what do we do if we want to delete all of the instances of a given value from our array? One option would be use ColdFusion 9's new ArrayFind() and ArrayDelete() methods in a conditional loop:

As you can see in the code, we keep looping while ArrayFind() returns a non-zero index. For every instance that ArrayFind() locates, we are then deleting it with ArrayDelete(). And, when we run this code, we get the following CFDump output:

This time, all three instances of "Sarah" were successfully removed from our girls array.

The above conditional CFLoop works, but it has a fundamental performance flaw: it searches the array twice as many times as it really needs to. The ArrayFind() method in the Condition searches the array to locate the given value; then, within loop body, the ArrayDelete() method searches the array to find the target value again (in order to delete it). Ideally, what we really want to do is capture the index returned by ArrayFind() and use it to delete the specific value within the array:

With this new code, we are only searching the array once with ArrayFind() and then deleting the target index with the old-school method, ArrayDeleteAt(). And, when we run this code, we get the same result with hypothetically better performance:

ArrayDelete() is one of the many minor but excellent updates that ColdFusion 9 brings to the table. However, it seems that this new function will be most useful when deleting a single value from a known array; once you have to delete more than the first instance of a value, you're going to get better performance if you fall back on the older method, ArrayDeleteAt(), which won't require a re-searching of the array.

What Other People Are Searching For

[ local search ] coldfusion 9 examples
[ local search ] coldfusion 9 tutorials
[ local search ] how to delete values from an array

You Might Also Be Interested In: