Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MatomoAnalyticsWiki: support for getting most visited pages #125

Closed
wants to merge 15 commits into from

Conversation

Universal-Omega
Copy link
Member

@Universal-Omega Universal-Omega commented Apr 5, 2024

Summary by CodeRabbit

  • New Features

    • Added functionality to retrieve the most visited pages in Matomo analytics.
  • Improvements

    • Enhanced getData method to include an optional date parameter and adjusted parameter types for better flexibility and functionality.

@Universal-Omega Universal-Omega changed the title Mostvisistedpages MatomoAnalyticsWiki: support for getting most visited pages Apr 5, 2024
@Universal-Omega
Copy link
Member Author

@coderabbitai review

Copy link

coderabbitai bot commented May 17, 2024

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

coderabbitai bot commented May 17, 2024

Walkthrough

The recent updates enhance the Matomo analytics integration by introducing a new method to retrieve the most visited pages and refining the data retrieval process. These changes include adding a getMostVisitedPages() method and updating the getData method with additional parameters and altered types to improve flexibility and functionality.

Changes

File Change Summary
includes/MatomoAnalyticsViewer.php Added getMostVisitedPages() method to the form descriptor array for retrieving most visited pages.
includes/MatomoAnalyticsWiki.php Updated getData method: added $date parameter, changed $flat type, and introduced $flatArray.

🐇
In the code, we made it bright,
With visits tracked both day and night.
Pages most viewed, now in sight,
Data flows with added might.
Analytics soar to new height,
Matomo's power in full flight.
🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 7032b17 and 9e65464.
Files selected for processing (2)
  • includes/MatomoAnalyticsViewer.php (1 hunks)
  • includes/MatomoAnalyticsWiki.php (4 hunks)
Additional comments not posted (2)
includes/MatomoAnalyticsWiki.php (2)

15-20: Ensure the new parameters in getData are well-documented.


30-33: The API request now correctly includes the new parameters.

@@ -27,6 +27,7 @@ public function getFormDescriptor(
'visitpages' => $mA->getVisitPages(),
'visitduration' => $mA->getVisitDurations(),
'visitpass' => $mA->getVisitDaysPassed(),
'mostvisited' => $mA->getMostVisistedPages(),
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in method name getMostVisistedPages().

- 'mostvisited' => $mA->getMostVisistedPages(),
+ 'mostvisited' => $mA->getMostVisitedPages(),

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
'mostvisited' => $mA->getMostVisistedPages(),
'mostvisited' => $mA->getMostVisitedPages(),

@@ -39,7 +42,7 @@ private function getData(
$arrayOut = [];

foreach ( $siteJson as $key => $val ) {
if ( $flat ) {
if ( $flatArray ) {
Copy link

@coderabbitai coderabbitai bot May 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider handling null values more gracefully in the conditional.

- $arrayOut[$key] = $val ?: '-';
+ $arrayOut[$key] = isset( $val ) ? $val : '-';

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
if ( $flatArray ) {
if ( $flatArray ) {
$arrayOut[$key] = isset( $val ) ? $val : '-';

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make sure there is a space inside the parentheses so isset( $val )

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Universal-Omega, thank you for pointing that out. I've adjusted the code snippet to include a space inside the parentheses as you requested:

$arrayOut[$key] = isset( $val ) ? $val : '-';

Please let me know if there's anything else you need!

Comment on lines +139 to +142
public function getMostVisistedPages() {
// We can also add support for linking to them through URLs with Actions.getPageUrls if we want
return $this->getData( 'Actions.getPageTitles', 'today', 'month', 'label', 'nb_visits', 1 );
}
Copy link

@coderabbitai coderabbitai bot May 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo in method name and consider making 'date' and 'period' parameters configurable.

- public function getMostVisistedPages() {
+ public function getMostVisitedPages() {
- return $this->getData( 'Actions.getPageTitles', 'today', 'month', 'label', 'nb_visits', 1 );
+ return $this->getData( 'Actions.getPageTitles', $date, $period, 'label', 'nb_visits', 1 );

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
public function getMostVisistedPages() {
// We can also add support for linking to them through URLs with Actions.getPageUrls if we want
return $this->getData( 'Actions.getPageTitles', 'today', 'month', 'label', 'nb_visits', 1 );
}
public function getMostVisitedPages( string $date, string $period ) {
// We can also add support for linking to them through URLs with Actions.getPageUrls if we want
return $this->getData( 'Actions.getPageTitles', $date, $period, 'label', 'nb_visits', 1 );
}

@Universal-Omega Universal-Omega deleted the mostvisistedpages branch October 25, 2024 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant