clones/friendica
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Changes: 

- added some missing type-hints
- fixed some documentation (e.g. empty * line between @param and @return/throws)
This commit is contained in:
Roland Häder 2022-07-19 16:27:32 +02:00
parent 4a11773d7e
commit 4e5179a7b3
No known key found for this signature in database
GPG Key ID: C82EDE5DDFA0BA77
3 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/Core/Search.php
View File

@ -54,19 +54,19 @@ class Search
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function getContactsFromProbe($user)
public static function getContactsFromProbe(string $user): ResultList
{
$emptyResultList = new ResultList(1, 0, 1);
if ((filter_var($user, FILTER_VALIDATE_EMAIL) && Network::isEmailDomainValid($user)) ||
(substr(Strings::normaliseLink($user), 0, 7) == "http://")) {
(substr(Strings::normaliseLink($user), 0, 7) == 'http://')) {
$user_data = Contact::getByURL($user);
if (empty($user_data)) {
return $emptyResultList;
}
if (!in_array($user_data["network"], Protocol::FEDERATED)) {
if (!in_array($user_data['network'], Protocol::FEDERATED)) {
return $emptyResultList;
}
@ -102,7 +102,7 @@ class Search
* @return ResultList
* @throws HTTPException\InternalServerErrorException
*/
public static function getContactsFromGlobalDirectory($search, $type = self::TYPE_ALL, $page = 1)
public static function getContactsFromGlobalDirectory(string $search, int$type = self::TYPE_ALL, int $page = 1): ResultList
{
$server = self::getGlobalDirectory();
@ -167,7 +167,7 @@ class Search
* @return ResultList
* @throws HTTPException\InternalServerErrorException
*/
public static function getContactsFromLocalDirectory($search, $type = self::TYPE_ALL, $start = 0, $itemPage = 80)
public static function getContactsFromLocalDirectory(string $search, int $type = self::TYPE_ALL, int $start = 0, int $itemPage = 80): ResultList
{
Logger::info('Searching', ['search' => $search, 'type' => $type, 'start' => $start, 'itempage' => $itemPage]);
@ -177,15 +177,15 @@ class Search
foreach ($contacts as $contact) {
$result = new ContactResult(
$contact["name"],
$contact["addr"],
$contact["addr"],
$contact["url"],
$contact["photo"],
$contact["network"],
$contact["cid"] ?? 0,
$contact["zid"] ?? 0,
$contact["keywords"]
$contact['name'],
$contact['addr'],
$contact['addr'],
$contact['url'],
$contact['photo'],
$contact['network'],
$contact['cid'] ?? 0,
$contact['zid'] ?? 0,
$contact['keywords']
);
$resultList->addResult($result);
@ -203,10 +203,11 @@ class Search
* @param string $search Name or part of a name or nick
* @param string $mode Search mode (e.g. "community")
* @param int $page Page number (starts at 1)
* @return array with the search results
*
* @return array with the search results or empty if error or nothing found
* @throws HTTPException\InternalServerErrorException
*/
public static function searchContact($search, $mode, int $page = 1)
public static function searchContact(string $search, string $mode, int $page = 1): array
{
Logger::info('Searching', ['search' => $search, 'mode' => $mode, 'page' => $page]);
@ -245,7 +246,7 @@ class Search
*
* @return string
*/
public static function getGlobalDirectory()
public static function getGlobalDirectory(): string
{
return DI::config()->get('system', 'directory', self::DEFAULT_DIRECTORY);
}
@ -254,9 +255,10 @@ class Search
* Return the search path (either fulltext search or tag search)
*
* @param string $search
*
* @return string search path
*/
public static function getSearchPath(string $search)
public static function getSearchPath(string $search): string
{
if (substr($search, 0, 1) == '#') {
return 'search?tag=' . urlencode(substr($search, 1));

4
src/Module/BaseSearch.php
View File

@ -47,7 +47,7 @@ class BaseSearch extends BaseModule
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
public static function performContactSearch($search, $prefix = '')
public static function performContactSearch(string $search, string $prefix = ''): string
{
$config = DI::config();
@ -113,7 +113,7 @@ class BaseSearch extends BaseModule
* @throws HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
protected static function printResult(ResultList $results, Pager $pager, $header = '')
protected static function printResult(ResultList $results, Pager $pager, string $header = ''): string
{
if ($results->getTotal() == 0) {
notice(DI::l10n()->t('No matches'));

4
src/Module/Search/Acl.php
View File

@ -65,7 +65,7 @@ class Acl extends BaseModule
System::jsonExit($o);
}
private static function globalContactSearch()
private static function globalContactSearch(): array
{
// autocomplete for global contact search (e.g. navbar search)
$search = trim($_REQUEST['search']);
@ -95,7 +95,7 @@ class Acl extends BaseModule
return $o;
}
private static function regularContactSearch(string $type)
private static function regularContactSearch(string $type): array
{
$start = $_REQUEST['start'] ?? 0;
$count = $_REQUEST['count'] ?? 100;