Overview

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • auth
        • ldap
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
      • exchange
        • rates
          • currency
            • layer
          • fixer
          • open
            • exchange
              • rates
          • x
            • rates
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • perforated
            • invoice
          • quickbooks
            • invoice
          • templates
            • default
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • reports
        • aging
          • invoices
        • client
          • data
            • portability
        • custom
          • report
        • invoice
          • creation
        • package
          • revenue
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • core
      • Automation
        • Tasks
          • Common
          • Task
        • Type
          • Common
          • Cron
      • Pricing
        • ItemComparator
        • MetaItem
        • Modifier
          • Type
            • Description
              • Type
                • Discount
                • Option
                • Service
                • Tax
            • Discount
            • Price
            • Proration
        • Presenter
          • Build
            • Invoice
            • InvoiceData
            • Options
            • Service
            • ServiceChange
            • ServiceData
          • Collection
          • Format
            • Fields
            • Type
              • Discount
              • Item
              • Option
              • Options
              • Package
              • Pricing
              • Service
              • Tax
          • Items
            • Invoice
            • Service
          • Type
      • ServiceProviders
      • Util
        • Captcha
          • Captchas
          • Common
        • Common
          • Traits
        • Events
          • Common
          • Handlers
          • Observers
        • Filters
          • Common
        • GeoIp
        • Input
          • Fields
            • Common
        • Tax
        • Widgets
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • helpers
      • color
      • data
        • structure
  • None
  • PHP

Classes

  • AmazonS3
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class AmazonS3

Amazon S3 component that backs up file data.

S3
Extended by AmazonS3
Package: blesta\components\net\amazon\s3
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/net/amazon_s3/amazon_s3.php
Methods summary
public
# __construct( string $access_key, string $secret_key, boolean $use_ssl = true, string $region = null )

Constructs a new AmazonS3 component, setting the credentials

Constructs a new AmazonS3 component, setting the credentials

Parameters

$access_key
The access key
$secret_key
The secret key
$use_ssl
Whether or not to use SSL when communicating
$region
The S3 region name
public string
# getRegion( )

Returns the region currently set

Returns the region currently set

Returns

string
The S3 region name
public static array
# getRegions( )

Returns an array of key/value pair region to region name mappings

Returns an array of key/value pair region to region name mappings

Returns

array
A key/value pair of region to region name mappings
public boolean
# upload( string $file, string $bucket, string $remote_file_name = null )

Uploads a file to Amazon S3

Uploads a file to Amazon S3

Parameters

$file
The full path of the file on the local system to upload
$bucket
The name of the bucket to upload to
$remote_file_name

The name of the file on the S3 server, null will default to the same file name as the local file

Returns

boolean
True if the file was successfully uploaded, false otherwise
Blesta API documentation generated by ApiGen