\Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations \Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups \Components\Customers\Groups\Contacts \Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Locations \Components\Settings\Administrators \Components\Settings\Domains \Components\Website\Analytics\Sessions \Components\Website\Comments \Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories \Framework\Architecture\PublicAssets \Framework\Assets\CSS \Framework\Assets\JavaScript \Framework\Caching\FileBased \Framework\Data\Util \Framework\Database\MainConnection \Framework\Date \Framework\DOM\Renderer \Framework\HTML\Converters \Framework\HTML\Highlighter \Framework\HTML\JavaScript \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\CIDR \Framework\Network\DNS \Framework\Network\GeoIP \Framework\Random \Framework\System\FileNames \Framework\System\FileSystem \Framework\Toasts
.
.
.
quick access
\ methods

\Components\Website\Media::

Class Methods

The following static methods are available on this class:
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
array getChildren($strMediaPath, $arrProperties)
Description
Returns all media underneath a folder
Parameters
$strMediaPath
string
$arrProperties
mixed
Return
array
string getImageAtSize($strFile, $iWidth, $iHeight, $bMaintainAspect, $bSupportsHiDPI, $bAllowUpscale, $bFullSuffix)
Description
Returns a URL of an image at the size supplied.

If $iWidth or $iHeight is not specified, a resize will occur only in the specified dimension.

When $bMaintainAspect is true, the image is restricted to the smaller dimension.

When $bSupportsHiDPI is true, an image will be served at the DPI of the current useragent. You are responsible for restricting the size of the image to the right screen dimensions. For instance, you might restrict it by setting width="" and height="" attributes on the <img> tag.
Parameters
$strFile
string
Source file name
$iWidth
int
Width in pixels
$iHeight
int
Height in pixels
$bMaintainAspect
bool
Whether or not to maintain aspect ratio. If set to 'crop' the image will be scaled and cropped.
$bSupportsHiDPI
bool
If true, and if we can determine the client is using a high DPI screen, then return an image with double the size.
$bAllowUpscale
bool
When true, allow creation of new image with dimensions larger than the natural image size.
$bFullSuffix
mixed
Return
URL

Database Fields

The following fields are used when retrieving and saving entities.
media_id
varchar (255)
media_link
varchar (255)
media_link_target
varchar (255)
media_name
varchar (255)
media_path
varchar (255)
media_size
int
media_size_formatted
varchar (255)
media_type
varchar (255)