Blesta
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • areyouahuman
      • auth
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
        • default
      • exchange
        • rates
          • google
            • finance
          • yahoo
            • finance
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • quickbooks
            • invoice
      • json
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • recaptcha
      • reports
        • aging
          • invoices
        • custom
          • report
        • invoice
          • creation
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • components
      • input
      • record
    • helpers
      • color
      • data
        • structure
      • date
      • form
      • html
      • javascript
      • xml
    • lib
  • None
  • PHP

Classes

  • AmazonS3

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
string
$access_key The access key
$secret_key
string
$secret_key The secret key
$use_ssl
boolean
$use_ssl Whether or not to use SSL when communicating $param string $region The S3 region name
$region
string
$endpoint Amazon URI

Overrides

S3::__construct
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
string
$file The full path of the file on the local system to upload
$bucket
string
$bucket The name of the bucket to upload to
$remote_file_name
string
$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

Methods inherited from S3

__getSignature(), __getTime(), copyObject(), createDistribution(), deleteBucket(), deleteDistribution(), deleteObject(), disableBucketLogging(), freeSigningKey(), getAccessControlPolicy(), getAuthenticatedURL(), getBucket(), getBucketLocation(), getBucketLogging(), getDistribution(), getDistributionInvalidationList(), getHttpUploadPostParams(), getObject(), getObjectInfo(), getSignedCannedURL(), getSignedPolicyURL(), hasAuth(), inputFile(), inputResource(), invalidateDistribution(), listBuckets(), listDistributions(), listOriginAccessIdentities(), putBucket(), putObject(), putObjectFile(), putObjectString(), setAccessControlPolicy(), setAuth(), setBucketLogging(), setBucketRedirect(), setEndpoint(), setExceptions(), setProxy(), setSSL(), setSSLAuth(), setSigningKey(), setTimeCorrectionOffset(), updateDistribution()

Magic methods summary

Constants summary

Constants inherited from S3

ACL_AUTHENTICATED_READ, ACL_PRIVATE, ACL_PUBLIC_READ, ACL_PUBLIC_READ_WRITE, SSE_AES256, SSE_NONE, STORAGE_CLASS_RRS, STORAGE_CLASS_STANDARD

Properties summary

Properties inherited from S3

$endpoint, $proxy, $sslCACert, $sslCert, $sslKey, $useExceptions, $useSSL, $useSSLValidation

Blesta API documentation generated by ApiGen 2.8.0