Actor Documents

From TMM Wiki
Revision as of 11:38, 18 November 2009 by Tmmdan (talk | contribs)
Jump to navigationJump to search
CARMA
Actors Admin
The Actors Admin
Add Actor
Actor Photos
Actor Documents
Manage Attribute Types
Creating Actor Pages

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 them.

Managing Documents

Go to Actors Admin and select the 2nd to last action icon to the right of the actor you want to manage the documents for.

Figure 1.1 - Actors Admin - Managing actor documents


Add a New Document

To add a new document your need to fill out the form that is below the document list. You can optionally provide a name to use for display and refernce purposes. If you leave the name field blank it will default to the name of the file.

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.1 - Actors Admin - Deleting a document

Accessing a document

If you choose to 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 like this:


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 2257)
  • <actorid> is the id of the actor that the document belongs to

Example:

http://members.mysite.com/view_doc.php?name=my_2257&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 documents.

Figure 4.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: