Piwik

# open source web analytics

http://piwik.org/

Les articles publiés sur le site

  • Piwik Mobile 2.1.1 with full support for iOS 8 and iPhone 6 Plus

    2 octobre 2014, par Thomas Steur — Piwik Mobile Releases

    Piwik Mobile 2.1.1 is now available and comes with full support for iOS 8 and iPhone 6 Plus.

    Please email us if you still experience any issues with this release.

    Thank you!

  • Piwik Mobile 2.1.1 with full support for iOS 8 and iPhone 6 Plus

    2 octobre 2014, par Thomas Steur — Piwik Mobile Releases

    Piwik Mobile 2.1.1 is now available and comes with full support for iOS 8 and iPhone 6 Plus.

    Please email us if you still experience any issues with this release.

    Thank you!

  • How to create a command – Introducing the Piwik Platform

    2 octobre 2014, par Thomas Steur — Development

    This is the next post of our blog series where we introduce the capabilities of the Piwik platform (our previous post was How to publish your plugin or theme on the Piwik Marketplace). This time you’ll learn how to create a new command. For this tutorial you will need to have basic knowledge of PHP.

    What is a command?

    A command can execute any task on the command line. Piwik provides currently about 50 commands via the Piwik Console. These commands let you start the archiver, change the number of available custom variables, enable the developer mode, clear caches, run tests and more. You could write your own command to sync users or websites with another system for instance.

    Getting started

    In this series of posts, we assume that you have already set up your development environment. If not, visit the Piwik Developer Zone where you’ll find the tutorial Setting up Piwik.

    To summarize the things you have to do to get setup:

    • Install Piwik (for instance via git).
    • Activate the developer mode: ./console development:enable --full.
    • Generate a plugin: ./console generate:plugin --name="MyCommandPlugin". There should now be a folder plugins/MyCommandPlugin.
    • And activate the created plugin under Settings => Plugins.

    Let’s start creating a command

    We start by using the Piwik Console to create a new command. As you can see there is even a command that lets you easily create a new command:

    ./console generate:command

    The command will ask you to enter the name of the plugin the created command should belong to. I will simply use the above chosen plugin name “MyCommandPlugin”. It will ask you for a command name as well. I will use “SyncUsers” in this example. There should now be a file plugins/MyCommandPlugin/Commands/Syncusers.php which contains already an example to get you started easily:

    class Syncusers extends ConsoleCommand
{
    protected function configure()
    {
        $this->setName('mycommandplugin:syncusers');
        $this->setDescription('MyCommandPlugin');
        $this->addOption('name', null, InputOption::VALUE_REQUIRED, 'Your name:');
    }

    /**
     * Execute command like: ./console mycommandplugin:syncusers --name="The Piwik Team"
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $name    = $input->getOption('name');

        $message = sprintf('Syncusers: %s', $name);

        $output->writeln($message);
    }
}

    Any command that is placed in the “Commands” folder of your plugin will be available on the command line automatically. Therefore, the newly created command can now be executed via ./console mycommandplugin:syncusers --name="The Piwik Team".

    The code template explained

    protected function configure()
{
    $this->setName('mycommandplugin:checkdatabase');
    $this->setDescription('MyCommandPlugin');
    $this->addOption('name', null, InputOption::VALUE_REQUIRED, 'Your name:');
}

    As the name says the method configure lets you configure your command. You can define the name and description of your command as well as all the options and arguments you expect when executing it. 

    protected function execute(InputInterface $input, OutputInterface $output)
{
    $name    = $input->getOption('name');
    $message = sprintf('Syncusers: %s', $name);
    $output->writeln($message);
}

    The actual task is defined in the execute method. There you can access any option or argument that was defined on the command line via $input and write anything to the console via $output argument.

    In case anything went wrong during the execution you should throw an exception to make sure the user will get a useful error message. Throwing an exception when an error occurs will make sure the command does exit with a status code different than 0 which can sometimes be important.

    Advanced features

    The Piwik Console is based on the powerful Symfony Console component. For instance you can ask a user for any interactive input, you can use different output color schemes and much more. If you are interested in learning more all those features have a look at the Symfony console website.

    How to test a command

    After you have created a command you are surely wondering how to test it. Ideally, the actual command is quite short as it acts like a controller. It should only receive the input values, execute the task by calling a method of another class and output any useful information. This allows you to easily create a unit or integration test for the classes behind the command. We will cover this topic in one of our future blog posts. Just one hint: You can use another command ./console generate:test to create a test. If you want to know how to test a command have a look at the Testing Commands documentation.

    Publishing your Plugin on the Marketplace

    In case you want to share your commands with other Piwik users you can do this by pushing your plugin to a public GitHub repository and creating a tag. Easy as that. Read more about how to distribute a plugin and best practices when publishing a plugin.

    Isn’t it easy to create a command? We never even created a file! If you have any feedback regarding our APIs or our guides in the Developer Zone feel free to send it to us.

  • How to create a command – Introducing the Piwik Platform

    2 octobre 2014, par Thomas Steur — Development

    This is the next post of our blog series where we introduce the capabilities of the Piwik platform (our previous post was How to publish your plugin or theme on the Piwik Marketplace). This time you’ll learn how to create a new command. For this tutorial you will need to have basic knowledge of PHP.

    What is a command?

    A command can execute any task on the command line. Piwik provides currently about 50 commands via the Piwik Console. These commands let you start the archiver, change the number of available custom variables, enable the developer mode, clear caches, run tests and more. You could write your own command to sync users or websites with another system for instance.

    Getting started

    In this series of posts, we assume that you have already set up your development environment. If not, visit the Piwik Developer Zone where you’ll find the tutorial Setting up Piwik.

    To summarize the things you have to do to get setup:

    • Install Piwik (for instance via git).
    • Activate the developer mode: ./console development:enable --full.
    • Generate a plugin: ./console generate:plugin --name="MyCommandPlugin". There should now be a folder plugins/MyCommandPlugin.
    • And activate the created plugin under Settings => Plugins.

    Let’s start creating a command

    We start by using the Piwik Console to create a new command. As you can see there is even a command that lets you easily create a new command:

    ./console generate:command

    The command will ask you to enter the name of the plugin the created command should belong to. I will simply use the above chosen plugin name “MyCommandPlugin”. It will ask you for a command name as well. I will use “SyncUsers” in this example. There should now be a file plugins/MyCommandPlugin/Commands/Syncusers.php which contains already an example to get you started easily:

    class Syncusers extends ConsoleCommand
{
    protected function configure()
    {
        $this->setName('mycommandplugin:syncusers');
        $this->setDescription('MyCommandPlugin');
        $this->addOption('name', null, InputOption::VALUE_REQUIRED, 'Your name:');
    }

    /**
     * Execute command like: ./console mycommandplugin:syncusers --name="The Piwik Team"
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $name    = $input->getOption('name');

        $message = sprintf('Syncusers: %s', $name);

        $output->writeln($message);
    }
}

    Any command that is placed in the “Commands” folder of your plugin will be available on the command line automatically. Therefore, the newly created command can now be executed via ./console mycommandplugin:syncusers --name="The Piwik Team".

    The code template explained

    protected function configure()
{
    $this->setName('mycommandplugin:checkdatabase');
    $this->setDescription('MyCommandPlugin');
    $this->addOption('name', null, InputOption::VALUE_REQUIRED, 'Your name:');
}

    As the name says the method configure lets you configure your command. You can define the name and description of your command as well as all the options and arguments you expect when executing it. 

    protected function execute(InputInterface $input, OutputInterface $output)
{
    $name    = $input->getOption('name');
    $message = sprintf('Syncusers: %s', $name);
    $output->writeln($message);
}

    The actual task is defined in the execute method. There you can access any option or argument that was defined on the command line via $input and write anything to the console via $output argument.

    In case anything went wrong during the execution you should throw an exception to make sure the user will get a useful error message. Throwing an exception when an error occurs will make sure the command does exit with a status code different than 0 which can sometimes be important.

    Advanced features

    The Piwik Console is based on the powerful Symfony Console component. For instance you can ask a user for any interactive input, you can use different output color schemes and much more. If you are interested in learning more all those features have a look at the Symfony console website.

    How to test a command

    After you have created a command you are surely wondering how to test it. Ideally, the actual command is quite short as it acts like a controller. It should only receive the input values, execute the task by calling a method of another class and output any useful information. This allows you to easily create a unit or integration test for the classes behind the command. We will cover this topic in one of our future blog posts. Just one hint: You can use another command ./console generate:test to create a test. If you want to know how to test a command have a look at the Testing Commands documentation.

    Publishing your Plugin on the Marketplace

    In case you want to share your commands with other Piwik users you can do this by pushing your plugin to a public GitHub repository and creating a tag. Easy as that. Read more about how to distribute a plugin and best practices when publishing a plugin.

    Isn’t it easy to create a command? We never even created a file! If you have any feedback regarding our APIs or our guides in the Developer Zone feel free to send it to us.

  • How to publish your plugin or theme on the Piwik Marketplace – Introducing the Piwik Platform

    25 septembre 2014, par Thomas Steur — Community, Development

    This is the next post of our blog series where we introduce the capabilities of the Piwik platform. Over the last weeks we have already introduced you to some of the basics on how to create plugins and themes. This time you’ll learn how to publish a plugin or theme on the Piwik Marketplace to share it with all Piwik users.

    What is the Piwik Marketplace?

    The Marketplace is a showcase for all plugins and themes that can be used in Piwik. You can browse them either on a standalone website or in Piwik itself by going to Settings => Marketplace. There you can install and update them with just one click. Easy as that! While some of those plugins are provided by Piwik or Piwik PRO most of them are created and maintained by our community. Everyone is very welcome to distribute plugins or themes on the Marketplace.

    Prerequisites

    To publish your plugin on the Marketplace you simply need to meet these requirements:

    • The plugin name is not already taken by another plugin
    • The code of the plugin is hosted in a public GitHub repository
    • The GitHub service “Piwik plugins” for this repository is enabled (Repository Settings => Webhooks & Services => Add Service)
    • Push permission for this repository
    • The plugin is free (as in not paid)
    • The license must be compatible with the GNU General Public License v3 or any later version

    There is also list of Rules for plugins.

    Best practices

    Before actually distributing your plugin we recommend to follow a couple of best practices to make sure your plugin looks good on the Marketplace and provides useful information for your future users. If you have used the console to generate a plugin the needed files were already created for you.

    Provide a good description

    Make sure there is a file named README.md in the root of your plugin. When preparing your plugin for the Marketplace we will search for four sections in this file: Description, FAQ, Changelog and Support. Each of those is optional but it is good practice to provide at least a section Description and Support by prefixing them with ## . Any content of your readme outside of those sections will not be displayed on the Marketplace.

    # Piwik Plugin Name

## Description

Add your plugin description here.

## Support

Please direct any feedback to hello@piwik.org. 
If you experience any issues feel free to file an issue at https://github.com/piwik/piwik/issues .

    A good example can be seen in the README.md of the CustomAlerts plugin and the related CustomAlerts plugin page.

    Provide screenshots

    This will improve your appearance in the Marketplace a lot and users will be more likely install your plugin. It is as easy as placing “png” or “jpg” files in a folder named screenshots. The filename of each image will be shown in the UI with underscores replaced by a whitespace. This way you can provide a nice description. Have a look at the CustomAlerts plugin to see how it works.

    Provide contact details

    Your contact details are specified in the plugin.json file of your plugin root folder. Providing at least one author and a link to your homepage is required. If you do not have a website you can use a link to your GitHub profile. This helps your users contact you in case they want to thank you for your great work or if they have any problem with it. An example plugin.json looks like this:

    {
    "name": "MyPluginName",
    "homepage": "http://piwik.org",
    "authors": [
        {
            "name": "Piwik",
            "email": "hello@piwik.org",
            "homepage": "http://piwik.org"
        }
    ],
    "support": {
      "email": "hello@piwik.org",
      "issues": "https://github.com/piwik/piwik/issues",
      "forum": "http://forum.piwik.org",
      "wiki": "https://github.com/piwik/piwik/wiki",
      "irc": "#piwik-dev"
    } 
}

    Choose a license

    Choosing the right license that works best for you and your users is important. To distribute a plugin via the Piwik Marketplace the license must be compatible with the GNU General Public License v3 or any later version. If you do not specify a license anywhere in your plugin, it is assumed your plugin uses GPLv3 or later. The license must be specified in the plugin.json file using the property license:

    {
    "name": "MyPluginName",
    "license": "GPL v3+"
}

    Provide donation links

    You can define a donation link or email for PayPal, Flattr and Bitcoin in the plugin.json file. Users that love your work will then be able to donate you money directly from the plugin page.

    {
    "name": "MyPluginName"
    "donate": {
        "paypal": "sponsor@piwik.org",
        "flattr": "https://flattr.com/profile/piwik",
        "bitcoin": "1234567890"
    }
}

    How to publish the first version of your plugin

    We are trying to make it as easy as possible for you to publish your plugin on the Marketplace. That’s why we don’t require any logins or packaging. To publish your plugin you only have to create a new tag of your plugin and within a minute your plugin will be ready to be installed on hundreds of thousands of Piwik installations.

    To tag your plugin you can use one of the following two suggestions:

    Using the command line

    git tag 0.1.0 && git push --tags

    Where “0.1.0” is the name of the tag. While you can use any tag name it is best practice to use the current version number as defined in the plugin.json file.

    Using GitHub UI

    To tag a new version via GitHub click on Releases => Draft a new release.

    Now you can enter a tag name (version) and press “Publish release” as shown in this screen. That’s it!

    How to provide an update for your plugin

    To provide an update you only have to increase the version number in the file plugin.json and create another tag as explained in the previous section. Your new Plugin update will be visible on the Marketplace within a minute or so. It might take a bit longer until the update appears in Piwik itself as each Piwik server only checks for updates every few hours.

    For a complete list of information go to our Distributing Your Plugin guide in the Piwik Developer Zone.

    If you have any feedback regarding our APIs or our guides in the Developer Zone feel free to let us know.

Navigation

Sites Web