Enclosure
class Enclosure
Model for streaming file attachments (enclosures).
Traits
Methods
Return a list of permitted audio mimetypes and extensions.
Return a list of permitted image mimetypes and extensions.
Return a list of permitted video mimetypes and extensions.
Returns an array of mimetypes that are permitted for upload to the media directory.
URL-encode and escape a query string for use in a URL.
Check that a string is comprised solely of alphanumeric characters.
Check that a string is comprised solely of alphanumeric characters and underscores.
Check that a string is comprised solely of alphabetical characters.
Cast to string, check UTF-8 encoding and strip trailing whitespace and control characters.
Initiate streaming of a downloadable media file associated with a content object.
Details
in Mimetypes at line 36
array
listAudioMimetypes()
Return a list of permitted audio mimetypes and extensions.
in Mimetypes at line 51
array
listImageMimetypes()
Return a list of permitted image mimetypes and extensions.
in Mimetypes at line 65
array
listVideoMimetypes()
Return a list of permitted video mimetypes and extensions.
in Mimetypes at line 85
array
listMimetypes()
Returns an array of mimetypes that are permitted for upload to the media directory.
NOTE: Adding HTML or any other scripting language or executable to this list would be a BAD IDEA, as such files can include PHP code, although uploaded files have execution permissions removed and are stored outside of the web root in order to prevent direct access by browser.
in ValidateString at line 41
string
encodeEscapeUrl(string $url)
URL-encode and escape a query string for use in a URL.
Trims, checks for UTF-8 compliance, rawurlencodes and then escapes with htmlspecialchars(). If you wish to use the data on a landing page you must decode it with htmlspecialchars_decode() followed by rawurldecode() in that order. But really, if you are using any characters that need to be encoded in the first place you should probably just stop.
in ValidateString at line 59
bool
isAlnum(string $alnum)
Check that a string is comprised solely of alphanumeric characters.
Accented regional characters are rejected. This method is designed to be used to check database identifiers or object property names.
in ValidateString at line 77
bool
isAlnumUnderscore(string $alnumUnderscore)
Check that a string is comprised solely of alphanumeric characters and underscores.
Accented regional characters are rejected. This method is designed to be used to check database identifiers or object property names.
in ValidateString at line 95
bool
isAlpha(string $alpha)
Check that a string is comprised solely of alphabetical characters.
Tolerates vanilla ASCII only. Accented regional characters are rejected. This method is designed to be used to check database identifiers or object property names.
in ValidateString at line 113
bool
isUtf8(string $text)
Check if the character encoding of text is UTF-8.
All strings received from external sources must be passed through this function, particularly prior to storage in the database.
in ValidateString at line 131
string
trimString(mixed $text)
Cast to string, check UTF-8 encoding and strip trailing whitespace and control characters.
Removes trailing whitespace and control characters (ASCII <= 32 / UTF-8 points 0-32 inclusive), checks for UTF-8 character set and casts input to a string. Note that the data returned by this function still requires escaping at the point of use; it is not database or XSS safe.
As the input is cast to a string do NOT apply this function to non-string types (int, float, bool, object, resource, null, array, etc).
at line 47
__construct(Database $database, CriteriaFactory $criteriaFactory)
Constructor.
at line 67
bool
streamFileToBrowser(int $id, string $filename = '')
Initiate streaming of a downloadable media file associated with a content object.
DOES NOT WORK WITH COMPRESSION ENABLED IN OUTPUT BUFFER. This method acts as an intermediary to provide access to uploaded file resources that reside outside of the web root, while concealing the real file path and name. Use this method to provide safe user access to uploaded files. If anything nasty gets uploaded nobody will be able to execute it directly through the browser.