From: Adam Magness Date: Mon, 15 Jan 2018 04:44:39 +0000 (-0500) Subject: Review updates X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=430bd7c6ac2ead5c72557e0fe2e004a41a21ba9b;p=friendica.git Review updates Update function name, descriptive variable names. --- diff --git a/mod/allfriends.php b/mod/allfriends.php index fc50eb2066..86f3f27e28 100644 --- a/mod/allfriends.php +++ b/mod/allfriends.php @@ -33,14 +33,14 @@ function allfriends_content(App $a) $uid = $a->user['uid']; - $c = dba::selectFirst('contact', ['name', 'url', 'photo'], ['id' => $cid, 'uid' => local_user()]); + $contact = dba::selectFirst('contact', ['name', 'url', 'photo'], ['id' => $cid, 'uid' => local_user()]); - if (!DBM::is_result($c)) { + if (!DBM::is_result($contact)) { return; } $a->page['aside'] = ""; - Profile::load($a, "", 0, Contact::getDetailsByURL($c[0]["url"])); + Profile::load($a, "", 0, Contact::getDetailsByURL($contact["url"])); $total = GContact::countAllFriends(local_user(), $cid); diff --git a/mod/cal.php b/mod/cal.php index 3527234a84..31ab5976b5 100644 --- a/mod/cal.php +++ b/mod/cal.php @@ -45,7 +45,7 @@ function cal_init(App $a) return; } - $profile = Profile::getProfiledataByNick($nick, $a->profile_uid); + $profile = Profile::getByNickname($nick, $a->profile_uid); $account_type = Contact::getAccountType($profile); diff --git a/mod/common.php b/mod/common.php index 472269f406..cfeb531f76 100644 --- a/mod/common.php +++ b/mod/common.php @@ -36,19 +36,19 @@ function common_content(App $a) } if ($cmd === 'loc' && $cid) { - $c = dba::selectFirst('contact', ['name', 'url', 'photo'], ['id' => $cid, 'uid' => $uid]); + $contact = dba::selectFirst('contact', ['name', 'url', 'photo'], ['id' => $cid, 'uid' => $uid]); - if (DBM::is_result($c)) { + if (DBM::is_result($contact)) { $a->page['aside'] = ""; - Profile::load($a, "", 0, Contact::getDetailsByURL($c["url"])); + Profile::load($a, "", 0, Contact::getDetailsByURL($contact["url"])); } } else { - $c = dba::selectFirst('contact', ['name', 'url', 'photo'], ['self' => true, 'uid' => $uid]); + $contact = dba::selectFirst('contact', ['name', 'url', 'photo'], ['self' => true, 'uid' => $uid]); - if (DBM::is_result($c)) { + if (DBM::is_result($contact)) { $vcard_widget = replace_macros(get_markup_template("vcard-widget.tpl"), array( - '$name' => htmlentities($c['name']), - '$photo' => $c['photo'], + '$name' => htmlentities($contact['name']), + '$photo' => $contact['photo'], 'url' => 'contacts/' . $cid )); @@ -59,7 +59,7 @@ function common_content(App $a) } } - if (!DBM::is_result($c)) { + if (!DBM::is_result($contact)) { return; } diff --git a/mod/hcard.php b/mod/hcard.php index 30c5d1ea26..87f5ef3207 100644 --- a/mod/hcard.php +++ b/mod/hcard.php @@ -9,7 +9,7 @@ use Friendica\Model\Profile; function hcard_init(App $a) { - $blocked = (((Config::get('system', 'block_public')) && (! local_user()) && (! remote_user())) ? true : false); + $blocked = Config::get('system', 'block_public') && !local_user() && !remote_user(); if ($a->argc > 1) { $which = $a->argv[1]; @@ -38,7 +38,7 @@ function hcard_init(App $a) $a->page['htmlhead'] .= '' . "\r\n"; } - if (! $blocked) { + if (!$blocked) { $keywords = ((x($a->profile, 'pub_keywords')) ? $a->profile['pub_keywords'] : ''); $keywords = str_replace(array(',',' ',',,'), array(' ',',',','), $keywords); if (strlen($keywords)) { diff --git a/mod/noscrape.php b/mod/noscrape.php index 4762d95464..bbf9020e84 100644 --- a/mod/noscrape.php +++ b/mod/noscrape.php @@ -34,7 +34,7 @@ function noscrape_init(App $a) $keywords = str_replace(array('#',',',' ',',,'), array('',' ',',',','), $keywords); $keywords = explode(',', $keywords); - $r = dba::selectFirst('contact', ['photo'], ['self' => true, 'uid' => $a->profile['uid']]); + $contactPhoto = dba::selectFirst('contact', ['photo'], ['self' => true, 'uid' => $a->profile['uid']]); $json_info = array( 'fn' => $a->profile['name'], @@ -44,7 +44,7 @@ function noscrape_init(App $a) 'key' => $a->profile['pubkey'], 'homepage' => System::baseUrl()."/profile/{$which}", 'comm' => (x($a->profile, 'page-flags')) && ($a->profile['page-flags'] == PAGE_COMMUNITY), - 'photo' => $r["photo"], + 'photo' => $contactPhoto["photo"], 'tags' => $keywords ); diff --git a/mod/photos.php b/mod/photos.php index 5da7de8387..ac1f06f8e8 100644 --- a/mod/photos.php +++ b/mod/photos.php @@ -49,7 +49,7 @@ function photos_init(App $a) { $a->profile_uid = $user[0]['uid']; $is_owner = (local_user() && (local_user() == $a->profile_uid)); - $profile = Profile::getProfiledataByNick($nick, $a->profile_uid); + $profile = Profile::getByNickname($nick, $a->profile_uid); $account_type = Contact::getAccountType($profile); diff --git a/mod/videos.php b/mod/videos.php index 9fab38b86a..1a9f57a396 100644 --- a/mod/videos.php +++ b/mod/videos.php @@ -42,7 +42,7 @@ function videos_init(App $a) { $a->data['user'] = $user[0]; $a->profile_uid = $user[0]['uid']; - $profile = Profile::getProfiledataByNick($nick, $a->profile_uid); + $profile = Profile::getByNickname($nick, $a->profile_uid); $account_type = Contact::getAccountType($profile); diff --git a/src/Model/Profile.php b/src/Model/Profile.php index 7df1623e1a..573af02c94 100644 --- a/src/Model/Profile.php +++ b/src/Model/Profile.php @@ -60,7 +60,7 @@ class Profile /** * - * @brief Loads a profile into the page sidebar. + * Loads a profile into the page sidebar. * * The function requires a writeable copy of the main App structure, and the nickname * of a registered local account. @@ -77,6 +77,7 @@ class Profile * the theme is chosen before the _init() function of a theme is run, which will usually * load a lot of theme-specific content * + * @brief Loads a profile into the page sidebar. * @param object $a App * @param string $nickname string * @param int $profile int @@ -106,7 +107,7 @@ class Profile } } - $pdata = self::getProfiledataByNick($nickname, $user[0]['uid'], $profile); + $pdata = self::getByNickname($nickname, $user[0]['uid'], $profile); if (empty($pdata) && empty($profiledata)) { logger('profile error: ' . $a->query_string, LOGGER_DEBUG); @@ -181,7 +182,7 @@ class Profile } /** - * @brief Get all profil data of a local user + * Get all profile data of a local user * * If the viewer is an authenticated remote viewer, the profile displayed is the * one that has been configured for his/her viewing in the Contact manager. @@ -190,12 +191,13 @@ class Profile * * Includes all available profile data * + * @brief Get all profile data of a local user * @param string $nickname nick * @param int $uid uid * @param int $profile_id ID of the profile - * @returns array + * @return array */ - public static function getProfiledataByNick($nickname, $uid = 0, $profile_id = 0) + public static function getByNickname($nickname, $uid = 0, $profile_id = 0) { if (remote_user() && count($_SESSION['remote'])) { foreach ($_SESSION['remote'] as $visitor) { @@ -243,11 +245,12 @@ class Profile } /** - * @brief Formats a profile for display in the sidebar. + * Formats a profile for display in the sidebar. * * It is very difficult to templatise the HTML completely * because of all the conditional logic. * + * @brief Formats a profile for display in the sidebar. * @param array $profile * @param int $block * @param boolean $show_connect Show connect link @@ -997,7 +1000,7 @@ class Profile } /** - * @brief Get the user ID of the page owner + * Get the user ID of the page owner. * * Used from within PCSS themes to set theme parameters. If there's a * puid request variable, that is the "page owner" and normally their theme @@ -1005,6 +1008,7 @@ class Profile * system pconfig, which means they don't want to see anybody else's theme * settings except their own while on this site. * + * @brief Get the user ID of the page owner * @return int user ID * * @note Returns local_user instead of user ID if "always_my_theme"