|
|
Frequently Asked Questions v2 |
| FAQ Main / Answer Detail |
Which parameters can I use with view.php3
Author: Honza actionapps@ecn.cz |
|
The only required parameter to view.php3 script is number of view to show. This parameter is given by vid url variable. All remaining parameters are optional.
Each optional view parameter begins with cmd[x], where x is view number in which the parameter should be used. This is needed because of possibility to include more than view to one shtml page. That's why we need to specify, for which view the command should work.
It is impossible to specify more than one cmd for one view. If you
want to use cmd[]=d for the view, you can't use it with
combination with cmd[]=c, for example.
Above is still true, even after CVS snapshot 20031109,
since when you can also use this syntax: vid=x&cmd[x][]=c-1-<something>&cmd[x][]=c-2-<something>.
Note the extra [].
However, you can use more settings (set[x]) per view. Just seperate settings with a comma, like: set[23]=from-10,to-20.
After the cmd[x]= is always character, which specify which command is used - how modify the view. The c command modifies conditions, for example. The values after command character are user parameters and its meaning is different for each command. The parameters are separated by '-' character. If you need to use a hyphen '-' in a parameter, use 2 hyphens '--' instead. Description of parameters is in following table of examples.
| Parameter example | Description |
| vid=4 | id of displayed view |
| cmd[23]=v-25 | show view id 25 in place of view id 23 |
| cmd[23]=i-24-7464647 | view number 23 has to display item 7464647 in format defined in view 24 |
| cmd[23]=x-24-1589 | The same as i, but there you can use both - short_id or long item id (as the last parameter) |
| cmd[23]=x-24-1589-1545-1612 | Display all three specified items. You can use as many ids as you want (the same works also for 'i' and 'o' cmd). This behavior is used for related fields, where related fields are displayed by{view.php3?vid=33&cmd[33]=x-33-{@relation.......1:-}}. |
| cmd[23]=x-24-url | keyword url means, that item id is taken from url parameter 'x=...' |
| cmd[23]=o-24-1589 | The same as x, but the number of item display (countHit) is not increased (as opposite to 'x' or 'i') |
| cmd[23]=c-1-ICT | display view no 23 in place of view no 23 (that's normal), but change value for condition 1 to "ICT" |
| cmd[23]=c-1-ICT-2-%22Jane%20Smith%22 |
the same as above, but there are redefined two conditions.
All three conditions could be redefined, notice how "Jane Smith"
requires urlencoded double quotes %22 or the search won't work, and the
space turned urlencoded to %20 otherwise it would be interepreted as
Jane OR Smith Since CVS snapshot 20031109 you can also use this syntax: cmd[23][]=c-1-ICT&cmd[23][]=c-2-%22Jane%20Smith%22 You do need to use this e.g. when you want to specify the first condition in your .shtml file, while second one comes from the URL |
| cmd[23]=d-headline........-LIKE-Profit-source.........1-=-Ecn-publish_date....-m:>-86400 | displays view no 23 and redefines the conditions. The conditions are in format field-operator-value. For list of possible operators see search caption. The operators could be with its modifiers, too. The unlimited number of conditions should be there specified. The speciefied conditions allways replaces all conditions specified in view definition (through admin interface). There are three diferences from cmd[]-c command - 1)operators and fields are specified, 2) default view conditions are ingnored, 3) there can be unlimitted number of conditions. The example would show items in which the headline contains 'Profit' and source field is 'Ecn' and the item is newer that one day. |
| cmd[23]=d-headline.......1,category........-RLIKE-Enviro | You can use more than one field in one condition. Example displays items where headline.......1 OR category........ begins with Enviro |
| set[23]=listlen-20 | setings to modify view behavior (can be combined with cmd) - sets maximal number of viewed items in view 23 to 20 - there can be more settings - comma separated |
| set[23]=sort-headline.......1 | set item order (use 'sort-headline.......1-' for descending sort order |
| set[23]=from-10 | - displays items from 10-th (in view 23) - it can be combined with listlen, to, ... parameters (set[23]=listlen-20,from-5) |
| set[23]=to-15 | - displays items to 15-th (in view 23) - usefull if combined with from parameter (set[23]=from-2,to-9) |
| set[23]=page-2-3 | - displays second page from 3 (in view 23) - it didvides all matching items into 3 pages and displays the second one. If you do not specify the second parameter (3 in our example), the page will be listlen items long. |
| set[23]=random-1 set[23]=random-number.........1 |
selects item(s) to show randomly. If you use the 'random-1' parameter, any item in Active bin is displayed. If You use field_id instead of '1', then the content of field specified by field_id is used as probability to show the item. Let's have two items. The parameter looks like 'random-number.........1'. The first item has the number.........1 filled with number 10, the second with 50. Then the second item will be displayed 5x more offten than the first one. The 'weight numbers' and 'number of displayed items' are unlimited. This feature is very good for banners. |
| set[23]=banner-2-38 set[23]=banner-2-38-number.........1 set[23]=banner-2-38-norandom |
by this parameter you are able to display any view (38 in or case) inserted just after the second (2) item in view (number 23). The item shown in inserted view (38) is selected randomly, possibly with weight specified in weight field (number.........1) - just like in random parameter described above. If you do not want use random item (banner), use 'norandom' keyword in place of 'weight field' (good for displaying nested newsbox). See also banner parameter for slice.php3. The example of included banner is on http://ecn.cz. |
| set[23]=noitem-Not%20found | - redefines the 'Not item found' message in view. |
| set[23]=slice_id-79a69a0ad73c81ac332b0e8c4c3cea93 | - redefines the slice from which the items will be displayed. |
| set[23]=slices-79a69a0ad73c81ac332b0e8c4c3cea93-45639a0ad73c81ac332b0e8c4c3cea44 | - display items from specified two or more slices. |
| als[alias] | user alias definition - you can define your own aliases in
url (for both - slice.php3 and view.php3). Aliases names MUST!!! be 8
characters long. Don't forgot, that the alias value have to be
urlencoded. Example: als[MY_ALIAS]=Summary%20Page (or maybe better: als%5BMY_ALIAS%5D=Summary%20Page) defines alias _#MY_ALIAS. If used in formatstring ('Admin - Design Index' for example), it prints 'Summary Page' |
| nocache=1 | URL parameter for pagerefresh - the view is not taken from cache (- no matter if the view is allready cached or not). Cache is updated. |
|
Last Edit: Aug 17 2011
<aafaq id=1766> ~ToDo: 1766 Which parameters can I use with view.php3 </aafaq>
This FAQ interface was developed by Jason at Commons.ca
|
 |
APC
ActionApps is a free software content management system initiated by
the Association for Progressive Communications (APC) APC - Internet and ICTs for social justice and development |