Fix PHPDoc comments project-wide
This commit is contained in:
		
					parent
					
						
							
								6077aa5847
							
						
					
				
			
			
				commit
				
					
						3282ce5389
					
				
			
		
					 113 changed files with 1703 additions and 795 deletions
				
			
		| 
						 | 
				
			
			@ -77,6 +77,7 @@ class CurlResult
 | 
			
		|||
	 * @param string $url optional URL
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return CurlResult a CURL with error response
 | 
			
		||||
	 * @throws InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	public static function createErrorCurl($url = '')
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -32,6 +32,7 @@ class FKOAuth1 extends OAuthServer
 | 
			
		|||
	/**
 | 
			
		||||
	 * @param string $uid user id
 | 
			
		||||
	 * @return void
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	public function loginUser($uid)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -35,6 +35,7 @@ class FKOAuthDataStore extends OAuthDataStore
 | 
			
		|||
	/**
 | 
			
		||||
	 * @param string $consumer_key key
 | 
			
		||||
	 * @return mixed
 | 
			
		||||
	 * @throws \Exception
 | 
			
		||||
	 */
 | 
			
		||||
	public function lookup_consumer($consumer_key)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -55,6 +56,7 @@ class FKOAuthDataStore extends OAuthDataStore
 | 
			
		|||
	 * @param string $token_type type
 | 
			
		||||
	 * @param string $token      token
 | 
			
		||||
	 * @return mixed
 | 
			
		||||
	 * @throws \Exception
 | 
			
		||||
	 */
 | 
			
		||||
	public function lookup_token($consumer, $token_type, $token)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -80,6 +82,7 @@ class FKOAuthDataStore extends OAuthDataStore
 | 
			
		|||
	 * @param string $nonce     nonce
 | 
			
		||||
	 * @param string $timestamp timestamp
 | 
			
		||||
	 * @return mixed
 | 
			
		||||
	 * @throws \Exception
 | 
			
		||||
	 */
 | 
			
		||||
	public function lookup_nonce($consumer, $token, $nonce, $timestamp)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -95,6 +98,7 @@ class FKOAuthDataStore extends OAuthDataStore
 | 
			
		|||
	 * @param string $consumer consumer
 | 
			
		||||
	 * @param string $callback optional, default null
 | 
			
		||||
	 * @return mixed
 | 
			
		||||
	 * @throws \Exception
 | 
			
		||||
	 */
 | 
			
		||||
	public function new_request_token($consumer, $callback = null)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -130,6 +134,7 @@ class FKOAuthDataStore extends OAuthDataStore
 | 
			
		|||
	 * @param string $consumer consumer
 | 
			
		||||
	 * @param string $verifier optional, defult null
 | 
			
		||||
	 * @return object
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	public function new_access_token($token, $consumer, $verifier = null)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -97,6 +97,7 @@ class Probe
 | 
			
		|||
	 * @param string $host The host part of an url
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array with template and type of the webfinger template for JSON or XML
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function hostMeta($host)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -188,6 +189,7 @@ class Probe
 | 
			
		|||
	 * @param string $hcard_url Link to the hcard - is returned by reference
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return string profile link
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	public static function webfingerDfrn($webbie, &$hcard_url)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -221,6 +223,7 @@ class Probe
 | 
			
		|||
	 * @param string $uri Address that should be probed
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array uri data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	public static function lrdd($uri)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -315,6 +318,8 @@ class Probe
 | 
			
		|||
	 * @param boolean $cache   Use cached values?
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array uri data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 * @throws \ImagickException
 | 
			
		||||
	 */
 | 
			
		||||
	public static function uri($uri, $network = '', $uid = -1, $cache = true)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -527,6 +532,7 @@ class Probe
 | 
			
		|||
	 * @param string $type      type
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array fixed webfinger data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function fixOStatus($webfinger, $lrdd, $type)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -572,6 +578,7 @@ class Probe
 | 
			
		|||
	 * @param integer $uid     User ID for the probe (only used for mails)
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array uri data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function detect($uri, $network, $uid)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -740,6 +747,7 @@ class Probe
 | 
			
		|||
	 * @param string $type type
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array webfinger data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function webfinger($url, $type)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -810,6 +818,7 @@ class Probe
 | 
			
		|||
	 * @param array  $data         The already fetched data
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array noscrape data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function pollNoscrape($noscrape_url, $data)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -926,6 +935,8 @@ class Probe
 | 
			
		|||
	 * @param string $profile_link Link to the profile page
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array profile data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 * @throws \ImagickException
 | 
			
		||||
	 */
 | 
			
		||||
	public static function profile($profile_link)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -976,6 +987,7 @@ class Probe
 | 
			
		|||
	 * @param array $webfinger Webfinger data
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array DFRN data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function dfrn($webfinger)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -1057,6 +1069,7 @@ class Probe
 | 
			
		|||
	 * @param boolean $dfrn      Poll DFRN specific data
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array hcard data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function pollHcard($hcard_url, $data, $dfrn = false)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -1181,6 +1194,7 @@ class Probe
 | 
			
		|||
	 * @param array $webfinger Webfinger data
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array Diaspora data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function diaspora($webfinger)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -1268,6 +1282,7 @@ class Probe
 | 
			
		|||
	 * @param bool  $short     Short detection mode
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array|bool OStatus data or "false" on error or "true" on short mode
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function ostatus($webfinger, $short = false)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -1450,6 +1465,7 @@ class Probe
 | 
			
		|||
	 *
 | 
			
		||||
	 * @param array $webfinger Webfinger data
 | 
			
		||||
	 *
 | 
			
		||||
	 * @param       $addr
 | 
			
		||||
	 * @return array pump.io data
 | 
			
		||||
	 */
 | 
			
		||||
	private static function pumpio($webfinger, $addr)
 | 
			
		||||
| 
						 | 
				
			
			@ -1552,6 +1568,7 @@ class Probe
 | 
			
		|||
	 * @param boolean $probe Do a probe if the page contains a feed link
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array feed data
 | 
			
		||||
	 * @throws HTTPException\InternalServerErrorException
 | 
			
		||||
	 */
 | 
			
		||||
	private static function feed($url, $probe = true)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -1614,6 +1631,7 @@ class Probe
 | 
			
		|||
	 * @param integer $uid User ID
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return array mail data
 | 
			
		||||
	 * @throws \Exception
 | 
			
		||||
	 */
 | 
			
		||||
	private static function mail($uri, $uid)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			@ -1701,6 +1719,7 @@ class Probe
 | 
			
		|||
	 * @param string $base   Another path that is hopefully complete
 | 
			
		||||
	 *
 | 
			
		||||
	 * @return string fixed avatar path
 | 
			
		||||
	 * @throws \Exception
 | 
			
		||||
	 */
 | 
			
		||||
	public static function fixAvatar($avatar, $base)
 | 
			
		||||
	{
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue