Software Note: Pods CMS 1.7.3 / WP 2.8.4

Documentation: http://pods.uproot.us/codex/magic_tags

What are Magic Tags

From Pods CMS’ documentation: Magic Tags are used exclusively within Pod templates to dynamically pull in column values.

Usage: {@column_name} / {@column_name,display_helper}

In addition to the documentation: {@column_name.another_column_name}

The above method allow you access a different Pod’s columns when it is a PICK column inside a pod.

Let’s say you have to two pods. The Person pod, and Country pod. The Person pod has a PICK column of the Country pod to identify the nationality of that person, and you want to list all the people as: Person’s Name, Country (where you want to access by: http://domain.com/person). So inside the Pod Templates you would have something like this to show:

<p>{@name}, {@country}</p>

The above displays something like below on the Person list page (http://domain.com/person):

Mon Lu, United States
John Smith, Canada
Ken Yamamoto, Japan

Now you want to get a bit sophisticated that you want to link the person’s name to its own detail page, and the country is linked to its own page listing all the people from that country or something like that. Not only that, you want to link the page using its own slugs/permalinks like this: http://domain.com/person/mon_lu and http://domain.com/country/usa – assuming you have a column named slug in the Person pod, and or abbrv in the Country pod. Before I figured this out, I used a Display Helper to grab the abbrv from the Country pod. But the easier way is the following, assuming this is still http://domain.com/person listing all the people where the Country pod is a PICK column inside the Person pod:

<p><a href="/person/{@slug}">{@name}</a><a href="/country/{@country.abbrv}">{@country}</a></p>

Simple enough, yeah?

No related posts.

Documentation: http://pods.uproot.us/codex/helpers

What are Input Helpers

An Input Helper lets you completely customize the appearance of any input field… when adding new data contents.

In plain n00b English: as an example, the default field “name” I had it to store last names, and a separate column to store first names (fname). The problem of that would be when you’re using Bi-directional relationship PICK column to another Pod (let’s call this: Person) is you can only relate one of the columns, not both First Name and Last Name. So if you use the PICK column the “name”; which stores the Last Names, and with the last name like Johnson – you probably can’t tell which Johnson that is. Input Helpers can grab and display the full names for you when you’re adding data. See screenshot:

How to add a new Input Helper

Customized Dropdown Input Helper

The following refers back to the example and screenshot above where it pulls full names from the “name” and “fname”columns as a PICK column to display as a drop down menu:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<select class="form pick1 <?php echo $name; ?>">
        <option value="">-- Select one --</option>
<?php
        if (!empty($value))
        {
            foreach ($value as $key => $val)
            {
                $lastname = $val['name'];
                $firstname = $val['firstname'];
                $fullname = $lastname.", ".$firstname;
                $selected = empty($val['active']) ? '' : ' selected';
?>
        <option value="<?php echo $val['id']; ?>"<?php echo $selected; ?>><?php echo $fullname; ?></option>
<?php
            }
        }
?>
    </select>

The crucial parts:

<select class="form pick1 <?php echo $name; ?>">

The class “form pick1″ are required by the default CSS unless you don’t care about the CSS. The $name is just an column’s name to identify the column’s name. Just like Display Helper, it passes the $value array for you to manipulate. The rest of the codes are very straight forward to read through the $value array, make sure that it actually have something in it before reading it. Then split it in parts to display. The $select is simply default select whatever previous selected when you are browsing existing content. If you’re adding new content, it is default to “–Select one–”. The very last part of this script is just simply displaying each option, giving each of them their unique row ID, then finally displaying the full names.

Another one I ran into was when I want to do a Multi PICK column, such as people who belong to a Dojo or Federation. See below:

I referenced the code above, with the help of FireBug, this saved the day:

Customized Multi PICK Column Input Helper

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

<div class="form pick <?php echo $name; ?>">
<?php
        if (!empty($value))
        {
            foreach ($value as $key => $val)
            {
                $lastname = $val['name'];
                $firstname = $val['firstname'];
                $fullname = $lastname.", ".$firstname;
                $active= empty($val['active']) ? '' : ' active';
?>
       <div class="option<?php echo $active; ?>" value="<?php echo $val['id']; ?>"><?php echo $fullname ; ?></div>
<?php
            }
        }
?>
</div>

As you’ve noticed, there are only minor differences between the two. The differences are “div” instead of “select”, $active, and the very last line (line 12). Obviously the very last line is the default CSS that used by Pods CMS for Multi PICK columns, unless you want something different.

Using the helpers

Simply click on the pencil/Edit icon of the column, and choose the helper. Like this:

Well, that’s it for now. I’ll update this section if I learn more.

No related posts.

The problem of this awesome plugin that it is quite new, the documentations, tutorials, and resources are quite limited. But the developers are extremely helpful on their own forum – so you’ll have to do a lot of digging to find the answers you need… in which I did. I also found the tutorials were kind of half way done, they stopped at displaying the data, but not showing how to write simple Display Helper and Input Helper. So I’m going to jog that down here.

If you have not gone through the documentations and have some basic data to play with, you should get going (thinking putting one simple guide of how to put all the pods together later).

Disclaimer:

The following helpers are very basic ones that I found myself used them a lot and repeatedly, so hopefully these will be useful for someone else also.  On a side note that I am NOT a hardcore PHP coder, I understood enough basic PHP codes to customize them. If you know a better way, feel free.

So let’s get rolling…

Software Note: Pods CMS 1.7.3 / WP 2.8.4

Documentation: http://pods.uproot.us/codex/helpers

Display Helpers: Display Helpers are the codes that help to display your results in a nicer, customized look.  For example, say that you want to show all of your ingredients in a recipe, by default, they’ll be list as such: “Ingredient 1Ingredient 2″ – it is hard to read.  So you can write a Display Helper to show them as “Ingredient 1, Ingredient 2″.  Got it?

By default, the Display Helper passes $value as an array for you to manipulate as such: $value[0][’column_name’].

Adding a Display Helper

Adding a new Display Helper is very simple, see below:

Pods CMS – Add new Display Helper

List Single Result ONLY (No Link)

Add a new Display Helper and name this one something like “print_r”:

<?php print_r($value[0]['name']); ?>

I have these two generic Display Helpers displaying a single result only.  By default, if you having something like {@column_name}, it will show column’s name and it is linked to a its own detailed page (if it is bi-directional), something like (http://domain.com/your_pod/column_name/1).  Where the very last part is actually the row ID.  So what if you want to display your data with a custom permalink/slug?  Such as: (http://domain.com/your_pod/slug_name)  This helper will come in handy in your Pod Templates page:

<a href="/pod_name/{@slug}">{@column_name,print_r}</a>

You probably noticed that I put the helpers right next to the Magic Tags instead of adding the Display Helpers like this:

Display Helper

It’s a matter of personal preference really. If you want, you can add the helper inside the admin interface. If you’d rather add the Display Helper through the admin interface, you don’t need to add “print_r” inside {@print_r}.

Displaying Arrays

The following will display “Ingredient 1, Ingredient 2, Ingredient 3″ instead of “Ingredient 1Ingredient 2Ingredient 3″ with links or no link to your liking:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<?php
$pod = pods_url_variable('first');
 
if (is_array($value) && 0 < count($value))
{
    foreach ($value as $val)
    {
        $output[] = "<a href='/".$pod."/".$val['slug']."' />".$val['name']."</a>";
    }
echo implode(', ', $output);
} else {
   echo "No record found";
}
?>

If you just want to display the results without the links, simply remove the “href” on line 8.

Note: This helper will only link to current pod, what I mean: “/pod1/slugname”, but not able to link “/pod2/slugname”. The reason is that this script will only grab the pod’s name which is “/pod1″ and add itself to the “a href…”. If you want to link to a different pod, you’ll just have to add a new helper with a minor change of instead of ‘$pod’ (line 8 ) where the “a href…” is to your actual pod’s name, make sense?

Well, that’s it for now… next up, Input Helper.

No related posts.