mirror of
https://github.com/friendica/friendica
synced 2025-04-25 21:50:12 +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
|
@ -841,12 +841,12 @@ class Contact extends BaseModule
|
|||
*
|
||||
* Available Pages are 'Status', 'Profile', 'Contacts' and 'Common Friends'
|
||||
*
|
||||
* @param App $a
|
||||
* @param array $contact The contact array
|
||||
* @param int $active_tab 1 if tab should be marked as active
|
||||
* @param App $a
|
||||
* @param array $contact The contact array
|
||||
* @param int $active_tab 1 if tab should be marked as active
|
||||
*
|
||||
* @return string | HTML string of the contact page tabs buttons.
|
||||
|
||||
* @return string HTML string of the contact page tabs buttons.
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public static function getTabsHTML($a, $contact, $active_tab)
|
||||
{
|
||||
|
|
|
@ -254,6 +254,7 @@ class Install extends BaseModule
|
|||
* @param App $a The global App
|
||||
*
|
||||
* @return string The text for the next steps
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private static function whatNext($a)
|
||||
{
|
||||
|
|
|
@ -79,6 +79,7 @@ class Login extends BaseModule
|
|||
*
|
||||
* @param string $openid_url OpenID URL string
|
||||
* @param bool $remember Whether to set the session remember flag
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private static function openIdAuthentication($openid_url, $remember)
|
||||
{
|
||||
|
@ -112,6 +113,7 @@ class Login extends BaseModule
|
|||
* @param string $username User name
|
||||
* @param string $password Clear password
|
||||
* @param bool $remember Whether to set the session remember flag
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private static function passwordAuthentication($username, $password, $remember)
|
||||
{
|
||||
|
@ -269,14 +271,15 @@ class Login extends BaseModule
|
|||
/**
|
||||
* @brief Wrapper for adding a login box.
|
||||
*
|
||||
* @param string $return_path The path relative to the base the user should be sent
|
||||
* back to after login completes
|
||||
* @param bool $register If $register == true provide a registration link.
|
||||
* This will most always depend on the value of config.register_policy.
|
||||
* @param array $hiddens optional
|
||||
* @param string $return_path The path relative to the base the user should be sent
|
||||
* back to after login completes
|
||||
* @param bool $register If $register == true provide a registration link.
|
||||
* This will most always depend on the value of config.register_policy.
|
||||
* @param array $hiddens optional
|
||||
*
|
||||
* @return string Returns the complete html for inserting into the page
|
||||
*
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
* @hooks 'login_hook' string $o
|
||||
*/
|
||||
public static function form($return_path = null, $register = false, $hiddens = [])
|
||||
|
|
|
@ -32,7 +32,6 @@ class Proxy extends BaseModule
|
|||
*
|
||||
* Sets application instance and checks if /proxy/ path is writable.
|
||||
*
|
||||
* @param \Friendica\App $app Application instance
|
||||
*/
|
||||
public static function init()
|
||||
{
|
||||
|
@ -157,6 +156,7 @@ class Proxy extends BaseModule
|
|||
* 'size' => requested image size (int)
|
||||
* 'sizetype' => requested image size (string): ':micro', ':thumb', ':small', ':medium', ':large'
|
||||
* ]
|
||||
* @throws \Exception
|
||||
*/
|
||||
private static function getRequestInfo()
|
||||
{
|
||||
|
@ -224,12 +224,13 @@ class Proxy extends BaseModule
|
|||
'sizetype' => $sizetype,
|
||||
];
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @brief setup ./proxy folder for direct cache
|
||||
*
|
||||
* @return bool False if direct cache can't be used.
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private static function setupDirectCache()
|
||||
{
|
||||
|
@ -248,16 +249,18 @@ class Proxy extends BaseModule
|
|||
|
||||
return $direct_cache;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @brief Try to reply with image in cachefile
|
||||
*
|
||||
* @param array $request Array from getRequestInfo
|
||||
* @param array $request Array from getRequestInfo
|
||||
*
|
||||
* @return string Cache file name, empty string if cache is not enabled.
|
||||
*
|
||||
*
|
||||
* If cachefile exists, script ends here and this function will never returns
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
* @throws \ImagickException
|
||||
*/
|
||||
private static function responseFromCache(&$request)
|
||||
{
|
||||
|
@ -269,13 +272,15 @@ class Proxy extends BaseModule
|
|||
}
|
||||
return $cachefile;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Try to reply with image in database
|
||||
*
|
||||
* @param array $request Array from getRequestInfo
|
||||
* @param array $request Array from getRequestInfo
|
||||
*
|
||||
* If the image exists in database, then script ends here and this function will never returns
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
* @throws \ImagickException
|
||||
*/
|
||||
private static function responseFromDB(&$request) {
|
||||
|
||||
|
@ -297,11 +302,12 @@ class Proxy extends BaseModule
|
|||
echo file_get_contents('images/blank.png');
|
||||
exit();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Output the image with cache headers
|
||||
*
|
||||
* @param Image $image
|
||||
* @param Image $img
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
private static function responseImageHttpCache(Image $img)
|
||||
{
|
||||
|
|
|
@ -53,6 +53,7 @@ class Tos extends BaseModule
|
|||
self::getApp()->internalRedirect('profile/' . Config::get('system','singleuser'));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief generate the content of the /tos page
|
||||
*
|
||||
|
@ -63,7 +64,8 @@ class Tos extends BaseModule
|
|||
* This privacy statement has fixed text, so it can be translated easily.
|
||||
*
|
||||
* @return string
|
||||
**/
|
||||
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
|
||||
*/
|
||||
public static function content() {
|
||||
$tpl = Renderer::getMarkupTemplate('tos.tpl');
|
||||
if (Config::get('system', 'tosdisplay')) {
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue