blog documentation FAQ followers forum marketplace services youtube

Seamless

The Jamroom Network » Documentation » Modules » Seamless

Table of Contents:


What does the Seamless module do?
Function {jrSeamless_list}
Example: Show a list of the 3 newest videos from Youtube or Vimeo

  • What does the Seamless module do?

    The jrSeamless module allows you to treat different types of items seamlessly when creating lists of items for your site.

    Any module that has a datastore can be included in a list created by the {jrSeamless_list} template function.

    This might be a list of all jrAudio items combined with a list of jrSoundCloud items.

    Or perhaps, jrVideo,jrYouTube and jrVimeo.

    If you want to make a list of different types of items, then this is what this module provides.

  • a normal list in JR5 list is created with {jrCore_list module="jrAudio" ......} Think of jrSeamless as that same functionality, but for multiple modules at once.

    {jrSeamless_list modules="jrAudio,jrSoundCloud" ......}

  • {jrSeamless_list}

    Function
    {jrSeamless_list}
    parameter
    type
    default
    required
    description
    modules
    string
    -
    on
    A comma separated list of modules to merge eg. modules="jrAudio,jrProfile,jrPage"
    profile_id
    int
    -
    off
    Filters the list by the specified profile id
    user_id
    int
    -
    off
    Filters the list by the specified user id
    search
    string
    -
    off
    Filters the list by the specified database 'column' condition eg. "_created >= 12345678912"
    search1
    string
    -
    off
    Note that multiple search parameters can be included eg. search1="" search2="".
    search2
    string
    -
    off
    Specific fields per module can also be searched provided that they are comma separated and in the same order as the modules list eg. modules="jrFile,jrAudio" search="file_file_item_price < 0.01,audio_download = on"
    search3
    string
    -
    off
    Also note the wildcard search eg. search="*_title = abcd" will return items with a title field of 'abcd' (module items without a title field will not be returned
    search?
    string
    -
    off
    As many search parameters can be added as required.
    template
    string
    -
    off
    Specifies the template that will process the results
    order_by
    string
    _created asc
    off
    The database 'column' that the results will be ordered by
    limit
    int
    10
    off
    Limits the number of results returned
    page
    int
    -
    off
    The page number of the returned results
    pagebreak
    int
    -
    off
    The number of returned results per page. Note that page and pagebreak must be used together
    sort_limit
    int
    1000000
    Set to a lower number to limit the number of results returned from each DataStore to determine sort order and pagination
    Similar to the core {jrCore_list} function except it searches multiple module datastores instead of just one.

  • Example: Show a list of the 3 newest videos from Youtube or Vimeo

    This code will return 3 items. The 3 newest items on the site. If that happens to be YouTube,YouTube,YouTube then that is what will be returned.

    Whichever is newer. If the latest videos are YouTube then Vimeo then YouTube again, that is what will show. Its asking for these two modules combined list, then get the 3 newest. 
    {jrSeamless_list modules="jrYouTube,jrVimeo" order_by="_created desc" limit="3"}

Tags