Created
October 3, 2012 19:48
-
-
Save adamjohnson/3829380 to your computer and use it in GitHub Desktop.
Working with Attributes in Concrete5, download this code and paste into a .html document
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!DOCTYPE html> | |
| <html> | |
| <head> | |
| <meta charset="utf-8"> | |
| <title>Working with Attributes in Concrete5</title> | |
| <style> | |
| pre { border: 1px solid black; padding:10px; } | |
| </style> | |
| </head> | |
| <body> | |
| <h1>Working with Attributes in Concrete5 CMS</h1> | |
| <h2>Overview</h2> | |
| <p>Attributes allow you to store bits of data with a page. This is useful for when you have pages which really contain bits of data, that we present to the user. Examples for a floor plan: Square Footage, Price, Floor Plan Image, etc. Originally compiled by <a href="http://twitter.com/raverix">Tim Dix (@raverix)</a>. More snippets can be found at <a href="http://www.weblicating.com/doku/doku.php?id=cheatsheet">the Weblicating Cheat Sheet</a>.</p> | |
| <p>To get the value of an attribute, you must first get a reference to the page you're working with. If you're working in one of the theme files, the variable is automatically set for you as:</p> | |
| <pre>$c</pre> | |
| <p>If you don't have a reference to the page variable, you must get a reference like so:</p> | |
| <pre>$c = Page::getCurrentPage();</pre> | |
| <p>With either method, once you've gotten your reference you will be able to use it the same way.</p> | |
| <p> </p><h2>Text</h2> | |
| <p>If the page you're working on has a text attribute with the handle "some_attribute", then you could display this to the user with the following:</p> | |
| <pre><?php echo $c->getAttribute('some_attribute') ?></pre><h2>Text Area</h2> | |
| <p>Similar to the text attribute, if the page you're working on has a text area attribute with the handle "some_attribute", then you could display this to the user with the following:</p> | |
| <pre><?php echo $c->getAttribute('some_attribute') ?></pre><h2>Checkbox</h2> | |
| <p>The checkbox attribute is useful if you want to store true/false, on/off type of information. For example; floor plan sold out, featured on special, has garage? To display information to the user using a checkbox attribute, we test the value of the checkbox, and display information based on it. Let's use the example of whether or not the unit has a garage. Let's name the attribute "floorplan_has_garage."</p> | |
| <pre>Garage: <?php echo $c->getAttribute('floorplan_has_garage') ? "Yes" : "No" ?> </pre> | |
| <p>If the checkbox is checked, anything within the first first set of double quotes (") will be displayed, otherwise, everything within the second set will be displayed. This will display "Garage: Yes" if the checkbox is selected, or "Garage: No" if not. </p> | |
| <p>If you had something like Sold Out, where you only wanted to display to the user if it's true, you can place everything in the first set of quotes, and leave the second one empty, like so:</p> | |
| <pre><?php echo $c->getAttribute('floorplan_sold_out') ? "<h2>Sold Out</h2>" : "" ?></pre><h2>Date/Time</h2> | |
| <p>Coming Soon</p><h2>Image/File</h2> | |
| <p>When you get a Image/File attribute, you get a reference to a file object. You can then do anything you need with that file object, depending on it's type. Because you're working with a complex data type, and not just a simple value, the first step in all of these is to ensure that you have a proper file, so we use the following:</p> | |
| <pre><?php<br>if($file = $c->getAttribute('some_file_attribute') )<br>{<br><span style="white-space: pre;"> </span>//Any thing we want to do on the image in here<br>} <br>?> </pre> | |
| <p>Display Image</p> | |
| <pre><?php<br>if($file = $c->getAttribute('some_image_attribute') )<br>{<br><span style="white-space: pre;"> </span>$ih = Loader::helper('image');<br><span> </span>$ih->output($file, $file->getTitle());<br>}<br>?> </pre> | |
| <p>Image Thumbnail, 100 max width, by 200 max height:</p> | |
| <pre><?php<br>if($file = $c->getAttribute('some_image_attribute') )<br>{<br><span style="white-space: pre;"> </span>$ih = Loader::helper('image');<br><span> </span>$ih->outputThumbnail($file, 100, 200, $file->getTitle());<br>}<br>?> </pre> | |
| <p>Download File</p> | |
| <pre><?php<br>if($file = $c->getAttribute('some_downloadable_attribute') )<br>{<br><span> </span>$url = $file->getVersion()->getDownloadURL();<br><span style="white-space: pre;"> echo "<a href='$url'>Download File</a>";</span><br>}<br>?> </pre> | |
| <p>Email Example (Absolute URL)</p> | |
| <pre><?php<br>if($file = $c->getAttribute('some_downloadable_attribute') )<br>{<br> $s = @getimagesize($file->getPath());<br> print '<img class="ccm-output-image" alt="' . $file->getTitle() . '" src="' .BASE_URL. $file->getRelativePath() . '" width="' . $s[0] . '" height="' . $s[1] . '" />';<br>} <br>?> </pre> | |
| </body> | |
| </html> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment