Actor Documents

CARMA About CARMA CARMA Requirements CARMA Changelog Setup Setting Up CARMA MySQL Settings Add Site Porting Sites to CARMA Moving CARMA Sites Admin The Sites Admin Site Sections Publish Mode Content Set Schedule Templates Admin Members Area Templates Tour Templates Member Favorites Smarty Loops Smarty Caching Smarty print array Base Templates User Variables Rating System   Template Functions CARMA Template Functions carma_actor_photo_name carma_comments_display carma_comments_form carma_count carma_favorite carma_gal_custom carma_get_extended carma_list carma_list_favorites carma_list_gals carma_list_third_party_content carma_list_videos carma_login_log carma_most_viewed carma_newest carma_news carma_poll carma_retrieve_sections carma_search carma_actors_search carma_show_gal carma_show_video carma_top_actors carma_top_rated carma_upcoming print_page_numbers Template Function Aliases carma_comment_display carma_display_comment carma_display_comments carma_extended carma_extended_data carma_get_extended_data carma_list_all Common Parameters assign assign_prefix count data_only display_on_assign start tpl Schedule Admin The Schedule Admin Scheduling Content Content Set Schedule Calendar Snapshot News Admin The News Admin Add News Auto News Feedback Admin The Feedback Admin The Polls Admin Gallery Content Admin The Gallery Content Admin Adding Content Edit Image Adding Image Text Content Set Locations Content Set Categories Managing Thumbnails Watermarking Image Removal Image Order Rotate Image Image Quality Video Content Admin The Video Content Admin Adding Content Video Clips Out of Order Video Thumbnails Content Set Locations Content Set Categories Video Format Flash Player Generate Flash Videos Using mp4 Videos Video Content Names Thumbnails Admin The Thumbnails Admin Image Thumbnail Video Thumbnails Third Parties Admin Third Party Content Scan Content Admin Scan Content Actors Admin The Actors Admin Add Actor Actor Photos Actor Documents Manage Attribute Types Creating Actor Pages Members Admin The Members Admin Member Details Stats Admin The Stats Admin Site Statistics Member's Statistics Content Statistics Actor's Statistics Accounts Admin Accounts Admin Add Account Access Levels Configuration Admin The Configuration Admin CARMA Configuration Variables Video Format Troubleshooting Common Errors Extras The Support Admin Admin Areas CARMA Home Pseudo Streaming Flash Player Using mp4 Videos Zipping Content Third Party Content X-Sendfile Xmoov-php TMMid

This article applies to CARMA 1.3.7.1 and greater

Recent changes to CARMA now allow you to upload documents for an actor. These documents can be in any format and contain anything you wish. An example use of this feature would be uploading 2257 documents. There is also a new script in the member scripts directory called view_doc.php that will allow you to create links to documents on your site if you wish to allow members to view select files.

Managing Documents

Go to Actors Admin and select the Documents icon to the right of the actor you want to edit.

Figure 1.1 - Actors Admin - Managing actor documents

On this page you will see two tables.  The first table, the Documents table, will list the current documents that CARMA has for this Actor. The second, the Add Document table is where you can add new documents.

Add a New Document

To add a new document fill in the form in the Add Document table. You can optionally provide a name to use for display and reference purposes. If you leave the name field blank it will default to the name of the file. By default all documents are private and accessible only through the CARMA Admin. If you wish for members to be able to have access to the file you are uploading then you should check the box next to Public.

Figure 1.2 - Actors Admin - Uploading a new document

Remove a Document

To remove a document, click the trash can to the right of the document you wish to delete.

Figure 1.3 - Actors Admin - Deleting a document

Accessing a document

If you choose, you can allow public access to select documents. You can do that on your member's templates with a link to the new script view_doc.php. This script should be called like one of the two examples below:

View Document Example 1

Format:

[YOUR_SITE]/view_doc.php?name=<name>&actorid=<actor_id>

• [YOUR_SITE] is your url to your members site.
• <name> is the name of the document that your provided when uploading it (such as my_story)
• <actorid> is the id of the actor that the document belongs to

Example:

http://members.mysite.com/view_doc.php?name=my_story&actorid=3

View Document Example 2

Format:

[YOUR_SITE]/view_doc.php?doc_id=<doc_id>&actorid=<actor_id>

• [YOUR_SITE] is your url to your members site.
• <doc_id> is the id of the document. See code below to get this id from the template functions
• <actorid> is the id of the actor that the document belongs to

Example:

<h2>Actors</h2>
{carma_list count=500 list="actors" order="name ASC"}
{foreach from=$carma_list.actor item=actor}
  {if $actor.photo}
    <img src="view_image.php?actorid={$actor.actorid}&width=150&height=150"><br>
  {else}
    [no photo]<br>
  {/if}
  {$actor.name}<br>
  {if $actor.docs}
     Documents:<br>
    {foreach from=$actor.docs item=doc}
       - <a href="view_doc.php?doc_id={$doc.doc_id}&actorid={$actor.actorid}">{$doc.name}</a><br>
    {/foreach}
  {/if}
  <hr>
{/foreach}

The above example will list the actor, their photo, and a list of all their public documents.

Figure 2.1 - Members Site - Sample Output of smarty code to show documents

Template Functions

All template functions that deal with actor data have been modified to have an array called docs. Modified templates are:

• carma_list_all
• carma_get_extended
• carma_top_rated
• carma_most_viewed
• carma_newest
• carma_upcoming
• carma_list_gals
• carma_list_videos
• carma_show_video
• carma_top_actors
• carma_favorite
• carma_search
• carma_list_favorites
• carma_get_actor_data