Difference between revisions of "Carma list"
From TMM Wiki
Jump to navigationJump to searchLine 3: | Line 3: | ||
}} | }} | ||
− | = | + | = carma_list and carma_list_all = |
− | * Purpose: | + | * Purpose: Retrieve actor, location, category or group data for one specific gallery or the whole database |
− | * Usage: { | + | * Usage: {carma_list list="actors,locations"} |
− | * Required: | + | * Required: list |
− | * Optional: count, start, section, order, | + | * Optional: galid, var, count, start, siteid, section, active, order, alpha_letters |
− | * Default Templates Used: | + | * Version: 1.3.0.1 or greater |
− | * Variables created: $ | + | * Default Templates Used: none |
+ | * Variables created: $carma_list, $params | ||
== Parameters == | == Parameters == | ||
Line 20: | Line 21: | ||
! Default Value | ! Default Value | ||
! Example | ! Example | ||
+ | |- | ||
+ | | '''list''' | ||
+ | | '''Defines what type of data you want carma_list to return.''' | ||
+ | | '''actors, locations, categories, groups, producers, orientation, type, quality, gender, race, hair, pubic, tits, dick, or body''' | ||
+ | | '''None.''' | ||
+ | | '''list="actors"''' | ||
+ | |- | ||
+ | | galid | ||
+ | | Only get the matching list for this gallery | ||
+ | | Any valid gallery I.D. number | ||
+ | | None. | ||
+ | | galid="123" | ||
|- | |- | ||
| [[count]] | | [[count]] | ||
− | | | + | | Maximum number of results to display (Click link for details) |
+ | | Zero or any whole number greater than zero | ||
+ | | 50 | ||
+ | | count=20 | ||
+ | |- | ||
+ | | [[start]] | ||
+ | | Hide all results lower than this number (Click link for details) | ||
| Any whole number greater than zero | | Any whole number greater than zero | ||
− | | | + | | ''None.'' (Doesn't hide any results) |
− | | | + | | start=10 |
|- | |- | ||
− | | | + | | siteid |
− | | | + | | The site the items belong to |
− | | Any | + | | Any valid site I.D. number |
− | | | + | | None. |
− | | | + | | siteid="123" |
|- | |- | ||
| section | | section | ||
− | | | + | | The section to get items from |
− | | A comma-delimited list of section I.D.s or a specific section I. | + | | A comma-delimited list of section I.D.s or a specific section I.Ds. |
− | | None | + | | None. |
| section="123" | | section="123" | ||
|- | |- | ||
− | |||
− | |||
− | |||
| active | | active | ||
− | | | + | | Limit the search to active content (requires siteid and section variables to be set) |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| 1 | | 1 | ||
− | | None. | + | | None. (Does not limit to active content.) |
− | | | + | | active="1" |
|- | |- | ||
− | | | + | | order |
− | | | + | | Which order to sort the gals in |
− | | | + | | active, caption, name |
− | + | | name | |
− | + | | order="active" | |
− | |||
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | | | ||
− | |||
|- | |- | ||
− | | | + | | alpha_letters |
− | | | + | | Only grab the list starting with these letters |
− | | | + | | A comma-delimited list of letters |
− | | | + | | None. |
− | | | + | | alpha_letters="A,B,C" |
|- | |- | ||
− | | | + | | var |
− | | | + | | The Smarty variable to assign data too |
− | | | + | | Any valid Smarty variable |
− | | | + | | carma_list |
− | | | + | | var="my_variable" |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Description == | == Description == | ||
− | + | This function retrieves a list of actors, locations, categories or | |
− | + | groups. By default CARMA retrieves all actors, locations, categories, | |
− | + | and groups stored in the CARMA database. If only want to retrieve a | |
+ | list matching a specific gallery, define galid in the call to | ||
+ | carma_list. The variables are stored in an array. For example, | ||
+ | actors are stored as $carma_list.actor[], categories are stored as | ||
+ | $carma_list.category[]. Each item in the array is again an array with | ||
+ | each field being one of the fields in the corresponding database table. | ||
− | == | + | == Example == |
+ | <pre> | ||
+ | {carma_list siteid=$siteid count=500 order="name ASC" list="actors,locations,groups,categories" } | ||
− | === | + | <form method="get" action="index.php"> |
− | + | <input type="hidden" name="section" value="{$secid}"> | |
− | + | Actor: <select size="5" name="actors"> | |
+ | {foreach from=$carma_list.actor item=actor} | ||
+ | <option value="{$actor.actorid}">{$actor.name}</option> | ||
+ | {/foreach} | ||
+ | </select> <br> | ||
+ | Category: <select size="5" name="category"> | ||
+ | {foreach from=$carma_list.category item=category} | ||
+ | <option value="{$category.catid}">{$category.name}</option> | ||
+ | {/foreach} | ||
+ | </select> <br> | ||
− | $ | + | Group: <select size="5" name="actors"> |
+ | {foreach from=$carma_list.group item=group} | ||
+ | <option value="{$group.gid}">{$group.name}</option> | ||
+ | {/foreach} | ||
+ | </select> <br> | ||
+ | |||
+ | Location: <select size="5" name="actors"> | ||
+ | {foreach from=$carma_list.location item=location} | ||
+ | <option value="{$location.locid}">{$location.name}</option> | ||
+ | {/foreach} | ||
+ | </select> <br> | ||
+ | <input type="submit" name="searching" value="Search"> | ||
+ | </pre> |
Revision as of 11:33, 8 June 2010
carma_list and carma_list_all
- Purpose: Retrieve actor, location, category or group data for one specific gallery or the whole database
- Usage: {carma_list list="actors,locations"}
- Required: list
- Optional: galid, var, count, start, siteid, section, active, order, alpha_letters
- Version: 1.3.0.1 or greater
- Default Templates Used: none
- Variables created: $carma_list, $params
Parameters
(Required parameters in bold)
Parameter | Description | Possible Values | Default Value | Example |
---|---|---|---|---|
list | Defines what type of data you want carma_list to return. | actors, locations, categories, groups, producers, orientation, type, quality, gender, race, hair, pubic, tits, dick, or body | None. | list="actors" |
galid | Only get the matching list for this gallery | Any valid gallery I.D. number | None. | galid="123" |
count | Maximum number of results to display (Click link for details) | Zero or any whole number greater than zero | 50 | count=20 |
start | Hide all results lower than this number (Click link for details) | Any whole number greater than zero | None. (Doesn't hide any results) | start=10 |
siteid | The site the items belong to | Any valid site I.D. number | None. | siteid="123" |
section | The section to get items from | A comma-delimited list of section I.D.s or a specific section I.Ds. | None. | section="123" |
active | Limit the search to active content (requires siteid and section variables to be set) | 1 | None. (Does not limit to active content.) | active="1" |
order | Which order to sort the gals in | active, caption, name | name | order="active" |
alpha_letters | Only grab the list starting with these letters | A comma-delimited list of letters | None. | alpha_letters="A,B,C" |
var | The Smarty variable to assign data too | Any valid Smarty variable | carma_list | var="my_variable" |
Description
This function retrieves a list of actors, locations, categories or groups. By default CARMA retrieves all actors, locations, categories, and groups stored in the CARMA database. If only want to retrieve a list matching a specific gallery, define galid in the call to carma_list. The variables are stored in an array. For example, actors are stored as $carma_list.actor[], categories are stored as $carma_list.category[]. Each item in the array is again an array with each field being one of the fields in the corresponding database table.
Example
{carma_list siteid=$siteid count=500 order="name ASC" list="actors,locations,groups,categories" } <form method="get" action="index.php"> <input type="hidden" name="section" value="{$secid}"> Actor: <select size="5" name="actors"> {foreach from=$carma_list.actor item=actor} <option value="{$actor.actorid}">{$actor.name}</option> {/foreach} </select> <br> Category: <select size="5" name="category"> {foreach from=$carma_list.category item=category} <option value="{$category.catid}">{$category.name}</option> {/foreach} </select> <br> Group: <select size="5" name="actors"> {foreach from=$carma_list.group item=group} <option value="{$group.gid}">{$group.name}</option> {/foreach} </select> <br> Location: <select size="5" name="actors"> {foreach from=$carma_list.location item=location} <option value="{$location.locid}">{$location.name}</option> {/foreach} </select> <br> <input type="submit" name="searching" value="Search">