Home / Articles / Adobe Creative Suite / How to Upload a File by Using the Flash FileReference Object

How to Upload a File by Using the Flash FileReference Object

  • Date: Apr 28, 2006.

Contents

  1. How to Code the ActionScript
  2. How to Write the PHP
  3. Conclusion

Article Description

Flash has long lacked the ability to upload files, a standard function in programming languages. Kris Hadlock cheers the addition of the FileReference object in Flash 8; by combining a bit of ActionScript and PHP, it's now quite simple to create a Flash file-uploading GUI.

Like this article? We recommend

Macromedia Flash 8: Training from the Source

Macromedia Flash 8: Training from the Source

$44.99

The FileReference class is a long-awaited addition to Flash. This class allows you to browse local drives on a user’s computer and provide the user with the ability to select files for upload by sending the file to a simple server-side script.

This article assumes that you have an understanding of ActionScript and basic knowledge of PHP. The sample download contains a fully functional, Flash file-uploading GUI with a PHP back-end to transport the files. I’ll show you how to write the ActionScript to handle the front-end FileReference code. The FileReference code will handle all possible situations, from canceling the upload to sending the file to a server-side script. Once we cover the ActionScript, I’ll show you a simple server-script for handling the upload and actually moving a file to the server.

How to Code the ActionScript

The FileReference class offers a robust set of methods and properties that cover many user interactions. In this section, we’ll see how to use this functionality to handle the front-end code. Before we can use the FileReference class, we must first import it:

import flash.net.FileReference;

Once the class has been imported, we can create an instance of the object, but before we do that we’ll create an array of file types that the object will accept. The following code creates an array of file types called fileTypes, which will contain an imageTypes object:

var fileTypes:Array = new Array();
var imageTypes:Object = new Object();
imageTypes.description = "Images (*.jpg, *.jpeg, *.gif, *.png)";
imageTypes.extension = "*.jpg; *.jpeg; *.gif; *.png";
fileTypes.push(imageTypes);

The imageTypes object contains a description string and an extensions string. The description string is what displays in the file-browsing dialog, and the extensions string is used to restrict the user’s file selection.

Now let’s add a way to trigger uploads and create an instance of the FileReference object. The sample uses a button to handle uploads and requires a listener object to handle the events. When the button is clicked, the listener fires the click event and creates a new FileReference object. The FileReference object then registers its own listener to listen for selected files, fires the browse method, and opens a file-browsing dialog. The file-browsing dialog takes the fileTypes array that we created earlier as a parameter.

var fileListener:Object = new Object();
var btnListener:Object = new Object();
btnListener.click = function(eventObj:Object)
{
  var fileRef:FileReference = new FileReference();
  fileRef.addListener(fileListener);
  fileRef.browse(fileTypes);
}
uploadButton.addEventListener("click", btnListener);

Now that the user can open the file-browsing dialog, we need to be able to handle various events that could occur. The first method that we’ll add is onCancel. This method handles user cancellations and accepts a FileReference parameter, which can be used for logging purposes or as a way to clean up the leftover object, which has been canceled and is no longer needed.

fileListener.onCancel = function(file:FileReference):Void
{
  resultsTxtField.text += "File Upload Cancelled\n";
}

The onSelect method is where all the action happens. Like the onCancel method, this method also accepts the FileReference object that was created and is being listened to by the corresponding listener. When the event is fired, this method is triggered, allowing us to take the selected file and do whatever we want with it. In the example, I invoke the upload method and pass the path to the server-side script that will handle transferring the file from the user’s local machine to the remote server. Since this method returns a Boolean stating whether or not it was successful, we’ll add an if statement to check the results. If the file upload returns false, we’ll write the result to the screen to alert the user that something went wrong.

fileListener.onSelect = function(file:FileReference):Void
{
  resultsTxtField.text += "File Selected: " + file.name;

  if(!file.upload("http://www.your domain.com/path to/upload.php"))
  {
    resultsTxtField.text += "Upload dialog failed to open.\n";
  }
}

The next method that we’ll add is onOpen; this method is triggered when the user’s file has been selected and is in the process of being added to the server. Like the other methods, onOpen takes a FileReference parameter.

fileListener.onOpen = function(file:FileReference):Void
{
  resultsTxtField.text += "File Opened: " + file.name + "\n";
}

In order to display the status of the file upload, we can use the onProgress method to display a loading message. This method takes a FileReference, bytesLoaded, and bytesTotal parameters. The bytesLoaded and bytesTotal parameters are the numbers that you’ll need to determine the progress of the upload and show the user how long it should take.

fileListener.onProgress = function(file:FileReference, bytesLoaded:Number, bytesTotal:Number):Void
{
  resultsTxtField.text += "Loading Progess: bytesLoaded: " + bytesLoaded + ", bytesTotal: " + bytesTotal + "\n";
}

The onComplete method is a great way to handle any events that you would like to happen when the file has been completely uploaded. For instance, you may want to display a completed message, redirect the user to another page, or even load an image that was uploaded to the page that the user is viewing.

fileListener.onComplete = function(file:FileReference):Void
{
  resultsTxtField.text += "File Upload Complete: " + file.name + "\n";
}
2. How to Write the PHP | Next Section

Adobe Press Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Adobe Press and its family of brands. I can unsubscribe at any time.

Overview

Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Adobe Press products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email ask@peachpit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security

Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children

This site is not directed to children under the age of 13.

Marketing

Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out

Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.adobepress.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links

This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020