Add PhpDoc
authorPhilipp Holzer <admin+github@philipp.info>
Mon, 20 May 2019 16:44:44 +0000 (18:44 +0200)
committerPhilipp Holzer <admin+github@philipp.info>
Mon, 20 May 2019 16:44:44 +0000 (18:44 +0200)
src/Core/Search.php

index c08d4eb..dcc2977 100644 (file)
@@ -5,14 +5,20 @@ namespace Friendica\Core;
 use Friendica\BaseObject;
 use Friendica\Database\DBA;
 use Friendica\Model\Contact;
-use Friendica\Network\Probe;
 use Friendica\Network\HTTPException;
+use Friendica\Network\Probe;
 use Friendica\Object\Search\ContactResult;
 use Friendica\Object\Search\ResultList;
 use Friendica\Protocol\PortableContact;
 use Friendica\Util\Network;
 use Friendica\Util\Strings;
 
+/**
+ * Specific class to perform searches for different systems. Currently:
+ * - Probe for contacts
+ * - Search in the local directory
+ * - Search in the global directory
+ */
 class Search extends BaseObject
 {
        const DEFAULT_DIRECTORY = 'https://dir.friendica.social';