The PHP JPEG Metadata Toolkit - Documentation

Go to Documentation - Home

Photoshop File Info Function Reference

Function: get_photoshop_file_info
Description: Retrieves Photoshop 'File Info' metadata in the same way that Photoshop does. The results are returned in an array as below:
                $file_info_array = array(
                        "title"                  => "",
                        "author"                 => "",
                        "authorsposition"        => "",      // Note: Not used in Photoshop 7 or higher
                        "caption"                => "",
                        "captionwriter"          => "",
                        "jobname"                => "",      // Note: Not used in Photoshop CS
                        "copyrightstatus"        => "",
                        "copyrightnotice"        => "",
                        "ownerurl"               => "",
                        "keywords"               => array( 0 => "", 1 => "", ... ),
                        "category"               => "",     // Note: Max 3 characters
                        "supplementalcategories" => array( 0 => "", 1 => "", ... ),
                        "date"                   => "",     // Note: DATE MUST BE IN YYYY-MM-DD format
                        "city"                   => "",
                        "state"                  => "",
                        "country"                => "",
                        "credit"                 => "",
                        "source"                 => "",
                        "headline"               => "",
                        "instructions"           => "",
                        "transmissionreference"  => "",
                        "urgency"                => "" );
                                        
Parameters: Exif_array an array containing the EXIF information to be searched, as retrieved by get_EXIF_JPEG.
XMP_array an array containing the XMP information to be searched, as retrieved by read_XMP_array_from_text.
IRB_array an array containing the Photoshop IRB information to be searched, as retrieved by get_Photoshop_IRB.
Returns: outputarray an array as above, containing the Photoshop File Info data




Function: put_photoshop_file_info
Description: Stores Photoshop "File Info" metadata in the same way that Photoshop does. The "File Info" metadata must be in an array similar to that returned by get_photoshop_file_info, as follows:
                $file_info_array = array(
                        "title"                  => "",
                        "author"                 => "",
                        "authorsposition"        => "",      // Note: Not used in Photoshop 7 or higher
                        "caption"                => "",
                        "captionwriter"          => "",
                        "jobname"                => "",      // Note: Not used in Photoshop CS
                        "copyrightstatus"        => "",
                        "copyrightnotice"        => "",
                        "ownerurl"               => "",
                        "keywords"               => array( 0 => "", 1 => "", ... ),
                        "category"               => "",     // Note: Max 3 characters
                        "supplementalcategories" => array( 0 => "", 1 => "", ... ),
                        "date"                   => "",     // Note: DATE MUST BE IN YYYY-MM-DD format
                        "city"                   => "",
                        "state"                  => "",
                        "country"                => "",
                        "credit"                 => "",
                        "source"                 => "",
                        "headline"               => "",
                        "instructions"           => "",
                        "transmissionreference"  => "",
                        "urgency"                => "" );
                                        
Parameters: jpeg_header_data a JPEG header data array in the same format as from get_jpeg_header_data. This contains the header information which is to be updated.
new_ps_file_info_array An array as above, which contains the "File Info" metadata information to be written.
Old_Exif_array an array containing the EXIF information to be updated, as retrieved by get_EXIF_JPEG.
Old_XMP_array an array containing the XMP information to be updated, as retrieved by read_XMP_array_from_text.
Old_IRB_array an array containing the Photoshop IRB information to be updated, as retrieved by get_Photoshop_IRB.
Returns: jpeg_header_data a JPEG header data array in the same format as from get_jpeg_header_data, containing the Photshop "File Info" metadata. This can then be written to a file using put_jpeg_header_data.
FALSE If an error occured