4.2. ACS 4 Photo Album Package Design Documentation

pa_image package

• pa_image.new creates a new pa_image object type and returns the cr_item.item_id of the newly created object. It also create the first revision of that object. It accepts an item_id and revision_id as arguments but both will be created if not provided. Although relation tag defaults to null it should be in (thumb, viewer, base). Path is the path to the image binary relative to the upload base (a parameterized directory).

      
        function new (
          name            in cr_items.name%TYPE,
          parent_id               in cr_items.parent_id%TYPE default null,
          item_id         in acs_objects.object_id%TYPE default null,
          revision_id             in acs_objects.object_id%TYPE default null,
          content_type    in acs_object_types.object_type%TYPE default 'pa_image',
          creation_date   in acs_objects.creation_date%TYPE default sysdate, 
          creation_user   in acs_objects.creation_user%TYPE default null, 
          creation_ip             in acs_objects.creation_ip%TYPE default null, 
          locale          in cr_items.locale%TYPE default null,
          context_id              in acs_objects.context_id%TYPE default null,
          title           in cr_revisions.title%TYPE default null,
          description             in cr_revisions.description%TYPE default null,
          mime_type               in cr_revisions.mime_type%TYPE default null,
          nls_language    in cr_revisions.nls_language%TYPE default null,
          relation_tag    in cr_child_rels.relation_tag%TYPE default null,
          is_live         in char default 'f',
          publish_date    in cr_revisions.publish_date%TYPE default sysdate,
          path            in pa_images.path%TYPE,
          height          in pa_images.height%TYPE default null,
          width           in pa_images.width%TYPE default null,
          file_size               in pa_images.file_size%TYPE default null
        ) return cr_items.item_id%TYPE;
       
                    
  

• pa_image.delte_revision deletes a specified revision of a pa_image and schedules the binary for deleation from the file-system by a sweep procedure

      
        procedure delete_revision (
          revision_id             in cr_revisions.revision_id%TYPE
        );
                    
  

• pa_image.delete deletes a pa_image and all revisions Also schedules the binary files for deletion from the file-system.

      
        procedure delete (
          item_id         in cr_items.item_id%TYPE
        );
                    
  

pa_photo package

• pa_photo.new create a new pa_photo object and returns the cr_item.item_id of the new object. Also creates first revision of object

      
        function new (
          name            in cr_items.name%TYPE,
          parent_id               in cr_items.parent_id%TYPE default null,
          item_id         in acs_objects.object_id%TYPE default null,
          revision_id             in acs_objects.object_id%TYPE default null,
          content_type    in acs_object_types.object_type%TYPE default 'pa_photo',
          creation_date   in acs_objects.creation_date%TYPE default sysdate, 
          creation_user   in acs_objects.creation_user%TYPE default null, 
          creation_ip             in acs_objects.creation_ip%TYPE default null, 
          locale          in cr_items.locale%TYPE default null,
          context_id              in acs_objects.context_id%TYPE default null,
          title           in cr_revisions.title%TYPE default null,
          description             in cr_revisions.description%TYPE default null,
          relation_tag    in cr_child_rels.relation_tag%TYPE default null,
          is_live         in char default 'f',
          publish_date    in cr_revisions.publish_date%TYPE default sysdate,
          mime_type               in cr_revisions.mime_type%TYPE default null,
          nls_language    in cr_revisions.nls_language%TYPE default null,
          caption         in pa_photos.caption%TYPE default null,
          story           in pa_photos.story%TYPE default null,
          user_filename   in pa_photos.user_filename%TYPE default null
        ) return cr_items.item_id%TYPE;
                    
  

• pa_photo.delete_revision deletes a specified revision of a pa_photo

      
        procedure delete_revision (
          revision_id             in acs_objects.object_id%TYPE
        );
                    
  

• pa_photo.delete deletes a pa_photo object, all revision of a pa_photo, and all associated pa_images (including binaries). Basically nukes a photo, so be careful using this one, because it can't be undone.

      
        procedure delete (
          item_id             in acs_objects.object_id%TYPE
        );
                    
  

pa_album package

• pa_album.new creates a new pa_album object type and returns the cr_item.item_id of the newly created object. It also create the first revision of that object. It accepts an item_id and revision_id as arguments but both will be created if not provided.

      
        function new (
           name           in cr_items.name%TYPE,
           album_id       in cr_items.item_id%TYPE default null,
           parent_id          in cr_items.parent_id%TYPE default null,
           revision_id    in cr_revisions.revision_id%TYPE default null,
           content_type   in acs_object_types.object_type%TYPE default 'pa_album',
           is_live            in char default 'f',
           creation_date  in acs_objects.creation_date%TYPE default sysdate, 
           creation_user  in acs_objects.creation_user%TYPE default null, 
           creation_ip    in acs_objects.creation_ip%TYPE default null, 
           locale     in cr_items.locale%TYPE default null,
           context_id         in acs_objects.context_id%TYPE default null,
           relation_tag   in cr_child_rels.relation_tag%TYPE default null,
           publish_date   in cr_revisions.publish_date%TYPE default sysdate,
           mime_type      in cr_revisions.mime_type%TYPE default null,
           nls_language   in cr_revisions.nls_language%TYPE default null,
           title      in cr_revisions.title%TYPE default null,
           description    in cr_revisions.description%TYPE default null,
           story      in pa_albums.story%TYPE default null
        ) return cr_items.item_id%TYPE;
                    
  

• pa_album.delte_revision deletes a specified revision of a pa_album

      
        procedure delete_revision (
          revision_id             in cr_revisions.revision_id%TYPE
        );
                    
  

• pa_album.delete deletes a pa_album and all revisions of that album. The album must not have any child pa_phots or the delete throws an error. So there is nothing equilent to rm -r *. You separately delete the photos in an album (or move them to a different album) then delete the album.

      
        procedure delete (
          album_id                in cr_items.item_id%TYPE
        );
                    
  

photo_album package

• photo_album.get_root_folder returns the root folder for a given package_id (package instance). The root folder for a package is actually cached by the web server. So it is probably faster to call the server proc pa_get_root_folder and pass the value in as a bind variable any place you need the root_folder in a query.

      
        function get_root_folder (
            package_id in apm_packages.package_id%TYPE
        ) return pa_package_root_folder_map.folder_id%TYPE;
                    
  

pa_get_root_folder {package_id ""} Returns the folder_id of the root folder for an instance of the photo album system. If no root folder exists, as when a new package instance is accessed for the first time, a new root folder is created automatically with appropriate permissions If value has be previously requested, value pulled from cache. If pakage_id is not specified, procedure uses value from [ad_conn package_id]

pa_context_bar_list {-final ""} item_id Constructs the list to be fed to ad_context_bar appropriate for item_id. If -final is specified, that string will be the last item in the context bar. Otherwise, the name corresponding to item_id will be used.

pa_make_file_name {-assert:boolean} {-ext ""} id Constructs a filename for an image based on id and extension. Files are created into a 3 tier directory structure: year/xx/zz/ for a photo_id 1234xxzz.jpg Same file would return year/xx/zz/1234xxzz.jpg. If -assert specified, proc creates directory and any parent directories if necessary

pa_is_folder_p folder_id {package_id ""} Returns "t" if folder_id is a folder that is a child of the root folder for the package, else "f". If package_id is not given procedure uses value from [ad_conn package_id].

pa_is_album_p album_id {package_id ""} Returns "t" if album_id is a album that is a child of the root folder for the package, else "f" If package_id is not given procedure uses value from [ad_conn package_id].

pa_is_photo_p photo_id {package_id ""} Returns "t" if photo_id is a photo that is a child of the root folder for the package, else "f" If package_id is not given procedure uses value from [ad_conn package_id].

pa_grant_privilege_to_creator object_id {user_id ""} Grants a set of default privileges stored in parameter PrivilegeForCreator on object id to user_id. If user_id is not specified, uses current user.

pa_image_width_height filename width_var height_var Uses ImageMagick program to get the width and height in pixels of filename. Sets height to the variable named in height_var in the calling level. Sets width_var to the variable named in width_var in the calling level. I Use ImageMagick instead of AOLserver function because it can handle more than just gifs and jpegs.

pa_make_new_image base_image new_image max_width {max_height ""} Uses ImageMagick program to create a file named new_image from base_image that fits within a box defined by max_width by max_height (in pixels). ImageMagick will retain the aspect ratio of the base_image when creating the new_image If max_height is not specified, max_width is used for max_height.

pa_all_photos_in_album album_id Returns a list of all the photo_ids in an album sorted in ascending order. Pulls value from cache if already there, caches result and returns result if not

pa_count_photos_in_album album_id Returns count of number of photos in album_id

pa_all_photos_on_page album_id page Returns a list of the photo_ids on page page of album_id. List is in ascending order

pa_count_pages_in_album album_id Returns the number of pages in album_id

pa_page_of_photo_in_album photo_id album_id Returns the page number of a photo in an album. If photo is not in the album returns -1

pa_flush_photo_in_album_cache album_id Clears the cacheed value set by pa_all_photos_in_album for a single album Call proc on any page that alters the number or order of photos in an album.

pa_pagination_page_number_links page total_pages Returns html table fragament for navigating pages of an album.

pa_photo_number_links cur_id all_ids Given a current photo_id and an ordered list of all the photo_id in an album, creates an html fragment that allows user to navigate to any photo by number, or next/previous. Pulls url from connection so should work on page showing a single photo based on photo_id (such as viewer size display page or base size display page).