keith/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added documentation

Browse source
This commit is contained in:
Michael Vogel 2016-04-17 20:55:19 +02:00
parent 49d52faab5
commit 502b660ca9
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
include/plaintext.php
View file

@ -1,4 +1,16 @@
<?php <?php
/**
* @brief Fetches attachment data that were generated the old way
*
* @param string $body Message body
* @return array
* 'type' -> Message type ("link", "video", "photo")
* 'text' -> Text outside of the shared message
* 'image' -> Preview image of the message
* 'url' -> Url to the attached message
* 'title' -> Title of the attachment
* 'description' -> Description of the attachment
*/
function get_old_attachment_data($body) { function get_old_attachment_data($body) {
$post = array(); $post = array();
@ -37,6 +49,19 @@ function get_old_attachment_data($body) {
return $post; return $post;
} }
/**
* @brief Fetches attachment data that were generated with the "attachment" element
*
* @param string $body Message body
* @return array
* 'type' -> Message type ("link", "video", "photo")
* 'text' -> Text before the shared message
* 'after' -> Text after the shared message
* 'image' -> Preview image of the message
* 'url' -> Url to the attached message
* 'title' -> Title of the attachment
* 'description' -> Description of the attachment
*/
function get_attachment_data($body) { function get_attachment_data($body) {
$data = array(); $data = array();