Available image properties in Smarty templates
This page lists the variables you can use on any page in Pixaria 2.0 where there is a single image on view. At the present time, this includes:
- Image detail view pages in gallery, search and lightbox
- Add to lightbox page
- Add to cart / purchase options page
To use any of these variables in your template, you need to enclose the entire variable in curly braces. For example to display the image caption use this code:
{$image.basic.caption}If you want to access the items in an array, like the $image.basic.keywords_array, you will need to use a Smarty 'section' construct. To illustrate this, the example below would print out a each keyword in the array followed by an HTML line break tag:
{section name="keywords" loop=$image.basic.keywords_array}
{$image.basic.keywords_array[keywords]}<br />
{sectionelse}
There were no keywords
{/section}Image detail variable list
| Smarty Variable Name | Type | Description |
| $image.basic.id | integer | The unique image ID from the database |
| $image.basic.active | boolean | Whether or not the image is active |
| $image.basic.path | string | name of the directory where the image is stored |
| $image.basic.userid | integer | The user ID of the person who owns this image |
| $image.basic.file_name | string | The image file name on the server |
| $image.basic.title | string | The image short title |
| $image.basic.caption | string | The image caption |
| $image.basic.file_type | string | The image MIME type |
| $image.basic.keywords | string | Image keywords separated by comma |
| $image.basic.keywords_array | array | Image keywords |
| $image.basic.keywords_array_escaped | array | Image keywords escaped with single quotes |
| $image.basic.keywords_present | boolean | Whether or not there are keywords |
| $image.basic.width | integer | Width of highest resolution image (pixels) |
| $image.basic.height | integer | Height of the highest resolution image (pixels) |
| $image.basic.copyright | string | Copyright holder of the image |
| $image.basic.headline | string | The image headling |
| $image.basic.date | string | MySQL timestamp |
| $image.basic.permissions | enum | Image permissions (10,11,12) |
| $image.basic.rights_type | boolean | Rights managed or royalty free |
| $image.basic.rights_text | string | Rights management information |
| $image.basic.colr_enable | boolean | Whether colour search is on for this image |
| $image.basic.colr_mod.0 | integer | Modulus of RGB red colour |
| $image.basic.colr_mod.1 | integer | Modulus of RGB green colour |
| $image.basic.colr_mod.2 | integer | Modulus of RGB blue colour |
| $image.basic.colr_hex.0 | string | Hexadecimal colour value for red |
| $image.basic.colr_hex.1 | string | Hexadecimal colour value for green |
| $image.basic.colr_hex.2 | string | Hexadecimal colour value for blue |
| $image.basic.colr_hex.3 | string | Complete hexadecimal colour code |
| $image.basic.colr_rgb.0 | integer | RGB colour value for red |
| $image.basic.colr_rgb.1 | integer | RGB colour value for green |
| $image.basic.colr_rgb.2 | integer | RGB colour value for blue |
| $image.basic.colr_rgb.3 | string | RGB colour vars separated by commas |
| $image.basic.price | float | Image price defined in database |
| $image.basic.calculated_price | float | Image price calculated from store settings |
| $image.basic.for_sale | boolean | Whether the image is for sale |
| $image.basic.image_product_link | boolean | Reserved |
| $image.basic.syndication | null | Reserved |
| $image.basic.syndication_url | null | Reserved |
| $image.basic.model_release | boolean | Image has a model release |
| $image.basic.property_release | boolean | Image has a property release |
| $image.basic.view_count | integer | Numer of times the image has been viewed |
| $image.basic.cart_link | boolean | Whether or not to show cart link |
| $image.basic.cart_add.url_default | string | Add to cart link href - from settings |
| $image.basic.cart_add.url_popup | string | Add to cart href - popup window |
| $image.basic.cart_add.url_inline | string | Add to cart href - same window |
| $image.basic.cart_add.url_inline_pop | string | Add to cart href - popup window template |
| $image.basic.lightbox_add.url_default | string | Add to lightbox href - from settings |
| $image.basic.lightbox_add.url_popup | string | Add to lightbox href - popup window |
| $image.basic.lightbox_add.url_inline | string | Add to lightbox href - same window |
| $image.basic.lightbox_add.url_inline_pop | string | Add to lightbox href - popup window template |
| $image.basic.trashed | boolean | Whether the image has been marked as trashed |
| $image.basic.content_type | null | Reserved |
| $image.basic.extra_01 | string | Configurable extra info 1 |
| $image.basic.extra_02 | string | Configurable extra info 2 |
| $image.basic.extra_03 | string | Configurable extra info 3 |
| $image.basic.extra_04 | string | Configurable extra info 4 |
| $image.basic.extra_05 | string | Configurable extra info 5 |
| $image.basic.iptc_creator | String | Image creator/byline |
| $image.basic.iptc_jobtitle | String | Image job title/byline title |
| $image.basic.iptc_city | String | Image city |
| $image.basic.iptc_country | String | Image country/primary location |
| $image.basic.iptc_credit | String | Image provider/credit |
| $image.basic.iptc_source | String | Image source |
| $image.basic.iptc_object | String | Image object name |
| $image.files.icon_path | string | Base64 encoded path to 32 x 32 image |
| $image.files.small_path | string | Base64 encoded path to 80 x 80 image |
| $image.files.large_path | string | Base64 encoded path to 160 x 160 image |
| $image.files.comp_path | string | Base64 encoded path to 630 x 630 image |
| $image.files.original_path | string | Base 64 encoded path to original image |
| $image.files.icon_size.0 | integer | Image width in pixels |
| $image.files.icon_size.1 | integer | Image height in pixels |
| $image.files.icon_size.2 | string | HTML width and height attributes for img tag |
| $image.files.icon_size.3 | float | Image aspect ratio |
| $image.files.small_size.0 | integer | Image width in pixels |
| $image.files.small_size.1 | integer | Image height in pixels |
| $image.files.small_size.2 | string | HTML width and height attributes for img tag |
| $image.files.small_size.3 | float | Image aspect ratio |
| $image.files.large_size.0 | integer | Image width in pixels |
| $image.files.large_size.1 | integer | Image height in pixels |
| $image.files.large_size.2 | string | HTML width and height attributes for img tag |
| $image.files.large_size.3 | float | Image aspect ratio |
| $image.files.comp_size.0 | integer | Image width in pixels |
| $image.files.comp_size.1 | integer | Image height in pixels |
| $image.files.comp_size.2 | string | HTML width and height attributes for img tag |
| $image.files.comp_size.3 | float | Image aspect ratio |
| $image.files.original_size.0 | integer | Image width in pixels |
| $image.files.original_size.1 | integer | Image height in pixels |
| $image.files.original_size.2 | string | HTML width and height attributes for img tag |
| $image.files.original_size.3 | float | Image aspect ratio |
| $image.files.icon_url | string | Full URL to 32 x 32 pixel image |
| $image.files.small_url | string | Full URL to 80 x 80 pixel image |
| $image.files.large_url | string | Full URL to 160 x 160 pixel image |
| $image.files.comp_url | string | Full URL to 630 x 630 pixel image |
| $image.files.original_url | string | Full URL to original image |
| $image.files.download_comp | string | URL to download comping image |
| $image.files.download_urls.jpg | string | URL to download high-res JPEG |
| $image.files.download_urls.jp2 | string | URL to download high-res JPEG 2000 |
| $image.files.download_urls.tif | string | URL to download high-res TIFF |
| $image.files.download_urls.psd | string | URL to download high-res Photoshop PSD |
| $image.extra.weight | string | Image weight in megabytes |
| $image.extra.max_print_size | string | Maximum printable size with calculation |
| $image.extra.products | Array | Products for this image |
Created: Friday, October 26, 2007
Last edited: Saturday, June 14, 2008
Tools & Utilities
Third Party Resources
 |
|
Random Tips & Tricks
#7 Random images If you'd like to display a random image from your library on a page of your site, use the 'Random Image' plug-in included with Pixaria. Installed plug-ins and their instructions can all be found in the admin control panel navigation under Main > Plug-ins. |
 |
Search documentation
RSS Syndication
