mirror of
https://github.com/friendica/friendica
synced 2025-04-25 20:30:11 +00:00
Fix PHPDoc comments project-wide
This commit is contained in:
parent
6077aa5847
commit
3282ce5389
113 changed files with 1703 additions and 795 deletions
|
@ -117,12 +117,13 @@ class HTML
|
|||
/**
|
||||
* Made by: ike@piratenpartei.de
|
||||
* Originally made for the syncom project: http://wiki.piratenpartei.de/Syncom
|
||||
* https://github.com/annando/Syncom
|
||||
* https://github.com/annando/Syncom
|
||||
*
|
||||
* @brief Converter for HTML to BBCode
|
||||
* @param string $message
|
||||
* @param string $basepath
|
||||
* @return string
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public static function toBBCode($message, $basepath = '')
|
||||
{
|
||||
|
@ -713,6 +714,7 @@ class HTML
|
|||
* @brief Convert video HTML to BBCode tags
|
||||
*
|
||||
* @param string $s
|
||||
* @return string
|
||||
*/
|
||||
public static function toBBCodeVideo($s)
|
||||
{
|
||||
|
@ -789,7 +791,9 @@ class HTML
|
|||
|
||||
/**
|
||||
* Loader for infinite scrolling
|
||||
*
|
||||
* @return string html for loader
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public static function scrollLoader()
|
||||
{
|
||||
|
@ -804,8 +808,10 @@ class HTML
|
|||
* Get html for contact block.
|
||||
*
|
||||
* @template contact_block.tpl
|
||||
* @hook contact_block_end (contacts=>array, output=>string)
|
||||
* @hook contact_block_end (contacts=>array, output=>string)
|
||||
* @return string
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
* @throws \ImagickException
|
||||
*/
|
||||
public static function contactBlock()
|
||||
{
|
||||
|
@ -890,22 +896,23 @@ class HTML
|
|||
/**
|
||||
* @brief Format contacts as picture links or as text links
|
||||
*
|
||||
* @param array $contact Array with contacts which contains an array with
|
||||
* int 'id' => The ID of the contact
|
||||
* int 'uid' => The user ID of the user who owns this data
|
||||
* string 'name' => The name of the contact
|
||||
* string 'url' => The url to the profile page of the contact
|
||||
* string 'addr' => The webbie of the contact (e.g.) username@friendica.com
|
||||
* string 'network' => The network to which the contact belongs to
|
||||
* string 'thumb' => The contact picture
|
||||
* string 'click' => js code which is performed when clicking on the contact
|
||||
* @param boolean $redirect If true try to use the redir url if it's possible
|
||||
* @param string $class CSS class for the
|
||||
* @param boolean $textmode If true display the contacts as text links
|
||||
* if false display the contacts as picture links
|
||||
|
||||
* @return string Formatted html
|
||||
*/
|
||||
* @param array $contact Array with contacts which contains an array with
|
||||
* int 'id' => The ID of the contact
|
||||
* int 'uid' => The user ID of the user who owns this data
|
||||
* string 'name' => The name of the contact
|
||||
* string 'url' => The url to the profile page of the contact
|
||||
* string 'addr' => The webbie of the contact (e.g.) username@friendica.com
|
||||
* string 'network' => The network to which the contact belongs to
|
||||
* string 'thumb' => The contact picture
|
||||
* string 'click' => js code which is performed when clicking on the contact
|
||||
* @param boolean $redirect If true try to use the redir url if it's possible
|
||||
* @param string $class CSS class for the
|
||||
* @param boolean $textmode If true display the contacts as text links
|
||||
* if false display the contacts as picture links
|
||||
* @return string Formatted html
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
* @throws \ImagickException
|
||||
*/
|
||||
public static function micropro($contact, $redirect = false, $class = '', $textmode = false)
|
||||
{
|
||||
// Use the contact URL if no address is available
|
||||
|
@ -947,10 +954,10 @@ class HTML
|
|||
* @param string $s Search query.
|
||||
* @param string $id HTML id
|
||||
* @param string $url Search url.
|
||||
* @param bool $save Show save search button.
|
||||
* @param bool $aside Display the search widgit aside.
|
||||
*
|
||||
* @return string Formatted HTML.
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public static function search($s, $id = 'search-box', $url = 'search', $aside = true)
|
||||
{
|
||||
|
@ -990,6 +997,7 @@ class HTML
|
|||
* Replace naked text hyperlink with HTML formatted hyperlink
|
||||
*
|
||||
* @param string $s
|
||||
* @return string
|
||||
*/
|
||||
public static function toLink($s)
|
||||
{
|
||||
|
@ -1006,6 +1014,7 @@ class HTML
|
|||
* @param string $html
|
||||
* @param array $reasons
|
||||
* @return string
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public static function applyContentFilter($html, array $reasons)
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue