\Website\Media
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media
DESCRIPTION
METHODS
getChildren()
getImageAtSize()
\Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

Media

Use this API get the contents of media folders.

Methods

Invoke via \Components\Website\Media::method()
Click a method name to copy it.
array getChildren($strMediaPath, $arrQuery)
Returns all media underneath a folder
Parameters
$strMediaPath
mixed
$arrQuery
mixed
Return
Array of Medias
string getImageAtSize($sResizableImageFilePath, $iWidth, $iHeight, $bMaintainAspect)
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.
Parameters
$sResizableImageFilePath
mixed
$iWidth
mixed
$iHeight
mixed
$bMaintainAspect
mixed
Return
URL (ie, client transformed filepath)

Database Fields

The following fields are used when retrieving and saving entities.
media_id
string (255)
media_name
string (255)
media_server_path
string (255)
media_url
string (255)
media_url_target
string (255)
media_type
string (255)