Advanced search

On other websites (7564)

• i use vitamio-ffmpeg achieve filters function,who can help me to see [on hold]

  30 December 2015, by 陈腾明

  my cmd is :
  ffmpeg -y -i /storage/emulated/0/Foream/a.mp4 -i /storage/emulated/0/Foream/q.jpg -filter_complex [0:v][1:v]overlay=main_w-overlay_w-10:main_h-overlay_h-10[out] -map [out] -map 0:a -codec:a copy /storage/test.mp4

  • ffmpeg version 2.0 Copyright (c) 2000-2013 the FFmpeg developers

    built on Dec 30 2015 17:40:40 with gcc 4.8 (GCC)
    
    configuration: --arch=arm --disable-runtime-cpudetect    --target-os=linux --enable-cross-compile --cross-prefix=arm-linux-androideabi- --enable-version3 --enable-optimizations --enable-shared --disable-fast-unaligned --disable-static --disable-symver --disable-programs --disable-doc --disable-avdevice --disable-postproc --disable-encoders --disable-muxers --enable-muxer=mp4 --disable-devices --disable-demuxer=sbg --disable-demuxer=dts --disable-parser=dca --disable-decoder=dca --disable-decoder=svq3 --disable-debug --enable-network --enable-asm --prefix=/var/vitamio/FFmpeg-Vitamio-vitamio/build/android/armv6 --extra-cflags='-mthumb -std=c99 -O3 -Wall -pipe -fpic -fasm -finline-limit=300 -ffast-math -fstrict-aliasing -Werror=strict-aliasing -Wno-psabi -Wa,--noexecstack -fdiagnostics-color=always -DANDROID -DNDEBUG -I/var/openssl/OpenSSL-Vitamio-master/include -D__ARM_ARCH_5__ -D__ARM_ARCH_5E__ -D__ARM_ARCH_5T__ -D__ARM_ARCH_5TE__ -march=armv6 -msoft-float' --extra-ldflags='-lm -lz -Wl,--no-undefined -Wl,-z,no   WARNING: library configuration mismatch
    
    avutil      configuration: --arch=arm --disable-runtime-cpudetect    --target-os=linux --cross-prefix=arm-linux-androideabi- --enable-cross-compile --enable-version3 --enable-shared --disable-static --disable-symver --disable-programs --disable-doc --disable-avdevice --disable-encoders --disable-muxers --disable-devices --disable-everything --disable-protocols --disable-demuxers --disable-decoders --disable-bsfs --disable-debug --enable-optimizations --enable-filters --enable-parsers --disable-parser=hevc --enable-swscale --enable-network --enable-protocol=file --enable-protocol=http --enable-protocol=rtmp --enable-protocol=rtp --enable-protocol=mmst --enable-protocol=mmsh --enable-protocol=crypto --enable-protocol=hls --enable-demuxer=hls --enable-demuxer=mpegts --enable-demuxer=mpegtsraw --enable-demuxer=mpegvideo --enable-demuxer=concat --enable-demuxer=mov --enable-demuxer=flv --enable-demuxer=rtsp --enable-demuxer=mp3 --enable-demuxer=matroska --enable-decoder=mpeg4 --enable-decoder=mpegvideo --enable-de   avcodec     configuration: --arch=arm --disable-runtime-cpudetect

    —target-os=linux —cross-prefix=arm-linux-androideabi- —enable-cross-compile —enable-version3 —enable-shared —disable-static —disable-symver —disable-programs —disable-doc —disable-avdevice —disable-encoders —disable-muxers —disable-devices —disable-everything —disable-protocols —disable-demuxers —disable-decoders —disable-bsfs —disable-debug —enable-optimizations —enable-filters —enable-parsers —disable-parser=hevc —enable-swscale —enable-network —enable-protocol=file —enable-protocol=http —enable-protocol=rtmp —enable-protocol=rtp —enable-protocol=mmst —enable-protocol=mmsh —enable-protocol=crypto —enable-protocol=hls —enable-demuxer=hls —enable-demuxer=mpegts —enable-demuxer=mpegtsraw —enable-demuxer=mpegvideo —enable-demuxer=concat —enable-demuxer=mov —enable-demuxer=flv —enable-demuxer=rtsp —enable-demuxer=mp3 —enable-demuxer=matroska —enable-decoder=mpeg4 —enable-decoder=mpegvideo —enable-de avformat configuration: —arch=arm —disable-runtime-cpudetect
    — target-os=linux —cross-prefix=arm-linux-androideabi- —enable-cross-compile —enable-version3 —enable-shared —disable-static —disable-symver —disable-programs —disable-doc —disable-avdevice —disable-encoders —disable-muxers —disable-devices —disable-everything —disable-protocols —disable-demuxers —disable-decoders —disable-bsfs —disable-debug —enable-optimizations —enable-filters —enable-parsers —disable-parser=hevc —enable-swscale —enable-network —enable-protocol=file —enable-protocol=http —enable-protocol=rtmp —enable-protocol=rtp —enable-protocol=mmst —enable-protocol=mmsh —enable-protocol=crypto —enable-protocol=hls —enable-demuxer=hls —enable-demuxer=mpegts —enable-demuxer=mpegtsraw —enable-demuxer=mpegvideo —enable-demuxer=concat —enable-demuxer=mov —enable-demuxer=flv —enable-demuxer=rtsp —enable-demuxer=mp3 —enable-demuxer=matroska —enable-decoder=mpeg4 —enable-decoder=mpegvideo —enable-de avfilter configuration: —arch=arm —disable-runtime-cpudetect
    — target-os=linux —cross-prefix=arm-linux-androideabi- —enable-cross-compile —enable-version3 —enable-shared —disable-static —disable-symver —disable-programs —disable-doc —disable-avdevice —disable-encoders —disable-muxers —disable-devices —disable-everything —disable-protocols —disable-demuxers —disable-decoders —disable-bsfs —disable-debug —enable-optimizations —enable-filters —enable-parsers —disable-parser=hevc —enable-swscale —enable-network —enable-protocol=file —enable-protocol=http —enable-protocol=rtmp —enable-protocol=rtp —enable-protocol=mmst —enable-protocol=mmsh —enable-protocol=crypto —enable-protocol=hls —enable-demuxer=hls —enable-demuxer=mpegts —enable-demuxer=mpegtsraw —enable-demuxer=mpegvideo —enable-demuxer=concat —enable-demuxer=mov —enable-demuxer=flv —enable-demuxer=rtsp —enable-demuxer=mp3 —enable-demuxer=matroska —enable-decoder=mpeg4 —enable-decoder=mpegvideo —enable-de swscale configuration: —arch=arm —disable-runtime-cpudetect
    — target-os=linux —cross-prefix=arm-linux-androideabi- —enable-cross-compile —enable-version3 —enable-shared —disable-static —disable-symver —disable-programs —disable-doc —disable-avdevice —disable-encoders —disable-muxers —disable-devices —disable-everything —disable-protocols —disable-demuxers —disable-decoders —disable-bsfs —disable-debug —enable-optimizations —enable-filters —enable-parsers —disable-parser=hevc —enable-swscale —enable-network —enable-protocol=file —enable-protocol=http —enable-protocol=rtmp —enable-protocol=rtp —enable-protocol=mmst —enable-protocol=mmsh —enable-protocol=crypto —enable-protocol=hls —enable-demuxer=hls —enable-demuxer=mpegts —enable-demuxer=mpegtsraw —enable-demuxer=mpegvideo —enable-demuxer=concat —enable-demuxer=mov —enable-demuxer=flv —enable-demuxer=rtsp —enable-demuxer=mp3 —enable-demuxer=matroska —enable-decoder=mpeg4 —enable-decoder=mpegvideo —enable-de swresample configuration: —arch=arm —disable-runtime-cpudetect
    — target-os=linux —cross-prefix=arm-linux-androideabi- —enable-cross-compile —enable-version3 —enable-shared —disable-static —disable-symver —disable-programs —disable-doc —disable-avdevice —disable-encoders —disable-muxers —disable-devices —disable-everything —disable-protocols —disable-demuxers —disable-decoders —disable-bsfs —disable-debug —enable-optimizations —enable-filters —enable-parsers —disable-parser=hevc —enable-swscale —enable-network —enable-protocol=file —enable-protocol=http —enable-protocol=rtmp —enable-protocol=rtp —enable-protocol=mmst —enable-protocol=mmsh —enable-protocol=crypto —enable-protocol=hls —enable-demuxer=hls —enable-demuxer=mpegts —enable-demuxer=mpegtsraw —enable-demuxer=mpegvideo —enable-demuxer=concat —enable-demuxer=mov —enable-demuxer=flv —enable-demuxer=rtsp —enable-demuxer=mp3 —enable-demuxer=matroska —enable-decoder=mpeg4 —enable-decoder=mpegvideo —enable-de libavutil 52. 48.100 / 52. 48.100
    libavcodec 55. 39.100 / 55. 39.100
    libavformat 55. 19.104 / 55. 19.104
    libavfilter 3. 90.100 / 3. 90.100
    libswscale 2. 5.101 / 2. 5.101
    libswresample 0. 17.104 / 0. 17.104
    Splitting the commandline.
    Reading option ’-y’ ... matched as option ’y’ (overwrite output files) with argument ’1’.
    Reading option ’-i’ ... matched as input file with argument ’/storage/emulated/0/Foream/a.mp4’.
    Reading option ’-i’ ... matched as input file with argument ’/storage/emulated/0/Foream/q.jpg’.
    Reading option ’-filter_complex’ ... matched as option ’filter_complex’ (create a complex filtergraph) with argument
    ’[0:v][1:v]overlay=main_w-overlay_w-10:main_h-overlay_h-10[out]’.
    Reading option ’-map’ ... matched as option ’map’ (set input stream mapping) with argument ’[out]’.
    Reading option ’-map’ ... matched as option ’map’ (set input stream mapping) with argument ’0:a’.
    Reading option ’-codec:a’ ... matched as option ’codec’ (codec name) with argument ’copy’.
    Reading option ’/storage/emulated/0/Foream/test.mp4’ ... matched as output file.
    Finished splitting the commandline.
    Parsing a group of options: global .
    Applying option y (overwrite output files) with argument 1.
    Applying option filter_complex (create a complex filtergraph) with argument
    [0:v][1:v]overlay=main_w-overlay_w-10:main_h-overlay_h-10[out].
    Successfully parsed a group of options.
    Parsing a group of options: input file /storage/emulated/0/Foream/a.mp4.
    Successfully parsed a group of options.
    Opening an input file: /storage/emulated/0/Foream/a.mp4.
    [mov,mp4,m4a,3gp,3g2,mj2 @ 0xb9270990] Format mov,mp4,m4a,3gp,3g2,mj2 probed with size=2048 and score=100
    [mov,mp4,m4a,3gp,3g2,mj2 @ 0xb9270990] ISO: File Type Major Brand: mp42
    [mov,mp4,m4a,3gp,3g2,mj2 @ 0xb9270990] File position before avformat_find_stream_info() is 810040
    [mov,mp4,m4a,3gp,3g2,mj2 @ 0xb9270990] All info found
    rfps: 29.416667 0.016512
    rfps: 29.416667 0.016512
    rfps: 29.500000 0.012847
    rfps: 29.500000 0.012847
    rfps: 29.583333 0.009693
    rfps: 29.666667 0.007050
    rfps: 29.750000 0.004918
    rfps: 29.833333 0.003298
    rfps: 29.916667 0.002188
    rfps: 30.000000 0.001590
    rfps: 30.083333 0.001503
    rfps: 30.166667 0.001928
    rfps: 30.250000 0.002863
    rfps: 30.333333 0.004310
    rfps: 30.333333 0.004310
    rfps: 30.416667 0.006268
    rfps: 30.416667 0.006268
    rfps: 30.500000 0.008737
    rfps: 30.500000 0.008737
    rfps: 30.583333 0.011717
    rfps: 30.583333 0.011717
    rfps: 30.666667 0.015208
    rfps: 30.666667 0.015208
    rfps: 30.750000 0.019211
    rfps: 30.750000 0.019211
    rfps: 59.500000 0.019673
    rfps: 59.583333 0.016176
    rfps: 59.666667 0.013191
    rfps: 59.750000 0.010716
    rfps: 59.833333 0.008753
    rfps: 59.916667 0.007302
    rfps: 60.000000 0.006361
    rfps: 29.970030 0.001747
    rfps: 59.940060 0.006986
    [mov,mp4,m4a,3gp,3g2,mj2 @ 0xb9270990] File position after avformat_find_stream_info() is 1684954
    Input #0, mov,mp4,m4a,3gp,3g2,mj2, from ’/storage/emulated/0/Foream/a.mp4’:
    Metadata:
    major_brand : mp42

      minor_version   :  0
    
    
    
      compatible_brands:  isommp42
    
    
    
      creation_time   :  2015-11-07 12:30:11
    
    
    
      location        :     +22.5935+113.8685/
    
    
    
      location-eng    :     +22.5935+113.8685/
    
    
    
    Duration:  00:00:17.24 , start: 

    0.000000 , bitrate: 9934 kb/s

      Stream #0:0 (eng) , 21, 1/90000 : Video: h264 (Constrained Baseline) (avc1 / 0x31637661), yuv420p, 1280x720, 9488 kb/s , SAR   

    65536:65536 DAR 16:9 , 29.61 fps , 30.08 tbr , 90k tbn , 50 tbc
    (default)

      Metadata:
    
    
    
    rotate          :  90
    
    
    
    
    
    creation_time   :  2015-11-07 12:30:11
    
    
    
    
    
    handler_name    :  VideoHandle
    
    
    
      Stream #0:1 (eng) , 49, 1/48000 : Audio: aac (mp4a / 0x6134706D), 48000 Hz, stereo, fltp, 96 kb/s  (default)
    
    
    
      Metadata:
    
    
    
    creation_time   :  2015-11-07 12:30:11
    
    
    
    
    
    handler_name    :  SoundHandle
    
    
    
      Successfully opened the file.
    
      Parsing a group of options: input file    /storage/emulated/0/Foream/q.jpg.
    
      Successfully parsed a group of options.
    
      Opening an input file: /storage/emulated/0/Foream/q.jpg.
    
      [mp3 @ 0xb924f040] Format mp3 detected only with low score of 1,    misdetection possible!
    
      [mp3 @ 0xb924f040] File position before avformat_find_stream_info()    is 0
    
      [mp3 @ 0xb9216ef0] Header missing
    
      [mp3 @ 0xb9216ef0] Header missing
    
      [mp3 @ 0xb9216ef0] Header missing
    
      [mp3 @ 0xb924f040] decoding for stream 0 failed
    
      [mp3 @ 0xb924f040] Could not find codec parameters for stream 0    (Audio: mp1, 0 channels, s16p): unspecified frame size Consider

    increasing the value for the ’analyzeduration’ and ’probesize’
    options
    [mp3 @ 0xb924f040] File position after avformat_find_stream_info() is 9590
    /storage/emulated/0/Foream/q.jpg: could not find codec parameters
    [AVIOContext @ 0xb9251990] Statistics: 9590 bytes read, 0 seeks
    [AVIOContext @ 0xb923e090] Statistics: 907698 bytes read, 1 seeks

• How to add new pages and menu items to Piwik – Introducing the Piwik Platform

  11 September 2014, by 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 create a widget). This time you’ll learn how to extend Piwik by adding new pages and menu items. For this tutorial you will need to have basic knowledge of PHP and optionally of Twig which is the template engine we use.

  What can be displayed in a page?

  To make it short: You can display any corporate related content, key metrics, news, help pages, custom reports, contact details, information about your server, forms to manage any data and anything else.

  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="MyControllerPlugin". There should now be a folder plugins/MyControllerPlugin.
  • And activate the created plugin under Settings => Plugins.

  Let’s start creating a page

  We start by using the Piwik Console to create a new page:

  ./console generate:controller

  The command will ask you to enter the name of the plugin the controller should belong to. I will simply use the above chosen plugin name “MyControllerPlugin”. There should now be two files plugins/MyControllerPlugin/Controller.php and plugins/MyControllerPlugin/templates/index.twig which both already contain an example to get you started easily:

  Controller.php

  class Controller extends \Piwik\Plugin\Controller
  {
      public function index()
      {
          return $this->renderTemplate('index', array(
               'answerToLife' => 42
          ));
      }
  }
  Download

  and templates/index.twig

  {% extends 'dashboard.twig' %}
   
  {% block content %}
      <strong>Hello world!</strong>
      <br/>
   
      The answer to life is {{ answerToLife }}
  {% endblock %}
  Download

  Note: If you are generating the Controller before Piwik 2.7.0 the example will look slightly different.

  The controller action index assigns the view variable answerToLife to the view and renders the Twig template templates/index.twig. Any variable assigned this way can then be used in the view using for example {{ answerToLife }}.

  Using a Twig template to generate the content of your page is actually optional: instead feel free to generate any content as desired and return a string in your controller action.

  As the above template index.twig is extending the dashboard template the Logo as well as the top menu will automatically appear on top of your content which is defined within the block content.

  

  How to display the page within the admin

  If you would like to add the admin menu on the left you have to modify the following parts:

  • Extend \Piwik\Plugin\ControllerAdmin instead of \Piwik\Plugin\Controller in the file Controller.php. In a future version of Piwik this step will be no longer neccessary, see #6151
  • Extend the template admin.twig instead of dashboard.twig
  • Define a headline using an H2-element

  {% extends 'admin.twig' %}
   
  {% block content %}
      <h2>Hello world!</h2>
      <br/>
   
      The answer to life is {{ answerToLife }}
  {% endblock %}
  Download

  Note: Often one needs to add a page to the admin to make a plugin configurable. We have a unified solution for this using the Settings API.

  

  How to display a blank page

  If you would like to generate a blank page that shows only your content the template should contain only your markup as follows:

  <strong>Hello world!</strong>
  <br/>
   
  The answer to life is {{ answerToLife }}
  Download

  Predefined variables, UI components, security and accessing query parameters

  In this blog post we only cover the basics to get you started. We highly recommend to read the MVC guide on our developer pages which covers some of those advanced topics. For instance you might be wondering how to securely access $_GET or $_POST parameters, you might want to restrict the content of your page depending on a user role, and much more.

  If you would like to know how to make use of JavaScript, CSS and Less have a look at our Working with Piwik’s UI guide.

  Note: How to include existing UI components such as a site selector or a date selector will be covered in a future blog post. Also, there are default variables assigned to the view depending on the context. A list of those variables that may or may not be defined is unfortunately not available yet but we will catch up on this.

  Let’s add a menu item to make the page accessible

  So far you have created a page but you can still not access it. Therefore we need to add a menu item to one of the Piwik menus. We start by using the Piwik Console to create a menu template:

  ./console generate:menu

  The command will ask you to enter the name of the plugin the menu should belong to. I will use again the above chosen plugin name “MyControllerPlugin”. There should now be a file plugins/MyControllerPlugin/Menu.php which contains an example to get you started easily:

  Menu.php

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          // reuse an existing category. 
          $menu->addManageItem('My User Item', $this->urlForAction('showList'));
   
          // or create a custom category
          $menu->addItem('My Custom Category', 'My User Item', $this->urlForDefaultAction());
      }
  }
  Download

  This is only a part of the generated template since all the examples of the different menus are similar. You can add items to four menus:

  • configureReportingMenu To add a new item to the reporting menu which includes all the reports like “Actions” and “Visitors”.
  • configureAdminMenu To add a new item to the admin menu which includes items like “User settings” and “Websites”.
  • configureTopMenu To add a new item to the top menu which includes items like “All Websites” and “Logout”.
  • configureUserMenu To add a new item to the user menu which is accessible when clicking on the username on the top right.

  In this blog post we will add a new item to the user menu and to do so we adjust the generated template like this:

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          $menu->addManageItem('My User Item', $this->urlForAction($method = 'index'), $orderId = 30);
      }
  }
  Download

  That’s it. This will add a menu item named “My User Item” to the “Manage” section of the user menu. When a user chooses the menu item, the “index” method of your controller will be executed and your previously created page will be first rendered and then displayed. Optionally, you can define an order to influence the position of the menu item within the manage section. Following this example you can add an item to any menu for any action. I think you get the point!

  

  Note: In Piwik 2.6.0 and before the above example would look like this:

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          $menu->addManageItem('My User Item', array($module = 'MyControllerPlugin', $action = 'index'), $orderId = 30);
      }
  }
  Download

  How to test a page

  After you have created your page you are surely wondering how to test it. A controller should be usually very simple as it is only the connector between model and view. Therefore, we do usually not create unit or integration test for controllers and for the view less than ever. Instead we would create a UI test that takes a screenshot of your page and compares it with an expected screenshot. Luckily, there is already a section UI tests in our Automated tests guide.

  Publishing your Plugin on the Marketplace

  In case you want to share your page 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.

  Advanced features

  Isn’t it easy to create a page? We never even created a file! Of course, based on our API design principle “The complexity of our API should never exceed the complexity of your use case.” you can accomplish more if you want: You can make use of Vanilla JavaScript, jQuery, AngularJS, Less and CSS, you can reuse UI components, you can access query parameters and much more.

  Would you like to know more about this? Go to our MVC (Model-View-Controller) and Working with Piwik’s UI guides in the Piwik Developer Zone.

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

• How to add new pages and menu items to Piwik – Introducing the Piwik Platform

  11 September 2014, by 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 create a widget). This time you’ll learn how to extend Piwik by adding new pages and menu items. For this tutorial you will need to have basic knowledge of PHP and optionally of Twig which is the template engine we use.

  What can be displayed in a page?

  To make it short: You can display any corporate related content, key metrics, news, help pages, custom reports, contact details, information about your server, forms to manage any data and anything else.

  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="MyControllerPlugin". There should now be a folder plugins/MyControllerPlugin.
  • And activate the created plugin under Settings => Plugins.

  Let’s start creating a page

  We start by using the Piwik Console to create a new page:

  ./console generate:controller

  The command will ask you to enter the name of the plugin the controller should belong to. I will simply use the above chosen plugin name “MyControllerPlugin”. There should now be two files plugins/MyControllerPlugin/Controller.php and plugins/MyControllerPlugin/templates/index.twig which both already contain an example to get you started easily:

  Controller.php

  class Controller extends \Piwik\Plugin\Controller
  {
      public function index()
      {
          return $this->renderTemplate('index', array(
               'answerToLife' => 42
          ));
      }
  }
  Download

  and templates/index.twig

  {% extends 'dashboard.twig' %}
   
  {% block content %}
      <strong>Hello world!</strong>
      <br/>
   
      The answer to life is {{ answerToLife }}
  {% endblock %}
  Download

  Note: If you are generating the Controller before Piwik 2.7.0 the example will look slightly different.

  The controller action index assigns the view variable answerToLife to the view and renders the Twig template templates/index.twig. Any variable assigned this way can then be used in the view using for example {{ answerToLife }}.

  Using a Twig template to generate the content of your page is actually optional: instead feel free to generate any content as desired and return a string in your controller action.

  As the above template index.twig is extending the dashboard template the Logo as well as the top menu will automatically appear on top of your content which is defined within the block content.

  

  How to display the page within the admin

  If you would like to add the admin menu on the left you have to modify the following parts:

  • Extend \Piwik\Plugin\ControllerAdmin instead of \Piwik\Plugin\Controller in the file Controller.php. In a future version of Piwik this step will be no longer neccessary, see #6151
  • Extend the template admin.twig instead of dashboard.twig
  • Define a headline using an H2-element

  {% extends 'admin.twig' %}
   
  {% block content %}
      <h2>Hello world!</h2>
      <br/>
   
      The answer to life is {{ answerToLife }}
  {% endblock %}
  Download

  Note: Often one needs to add a page to the admin to make a plugin configurable. We have a unified solution for this using the Settings API.

  

  How to display a blank page

  If you would like to generate a blank page that shows only your content the template should contain only your markup as follows:

  <strong>Hello world!</strong>
  <br/>
   
  The answer to life is {{ answerToLife }}
  Download

  Predefined variables, UI components, security and accessing query parameters

  In this blog post we only cover the basics to get you started. We highly recommend to read the MVC guide on our developer pages which covers some of those advanced topics. For instance you might be wondering how to securely access $_GET or $_POST parameters, you might want to restrict the content of your page depending on a user role, and much more.

  If you would like to know how to make use of JavaScript, CSS and Less have a look at our Working with Piwik’s UI guide.

  Note: How to include existing UI components such as a site selector or a date selector will be covered in a future blog post. Also, there are default variables assigned to the view depending on the context. A list of those variables that may or may not be defined is unfortunately not available yet but we will catch up on this.

  Let’s add a menu item to make the page accessible

  So far you have created a page but you can still not access it. Therefore we need to add a menu item to one of the Piwik menus. We start by using the Piwik Console to create a menu template:

  ./console generate:menu

  The command will ask you to enter the name of the plugin the menu should belong to. I will use again the above chosen plugin name “MyControllerPlugin”. There should now be a file plugins/MyControllerPlugin/Menu.php which contains an example to get you started easily:

  Menu.php

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          // reuse an existing category. 
          $menu->addManageItem('My User Item', $this->urlForAction('showList'));
   
          // or create a custom category
          $menu->addItem('My Custom Category', 'My User Item', $this->urlForDefaultAction());
      }
  }
  Download

  This is only a part of the generated template since all the examples of the different menus are similar. You can add items to four menus:

  • configureReportingMenu To add a new item to the reporting menu which includes all the reports like “Actions” and “Visitors”.
  • configureAdminMenu To add a new item to the admin menu which includes items like “User settings” and “Websites”.
  • configureTopMenu To add a new item to the top menu which includes items like “All Websites” and “Logout”.
  • configureUserMenu To add a new item to the user menu which is accessible when clicking on the username on the top right.

  In this blog post we will add a new item to the user menu and to do so we adjust the generated template like this:

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          $menu->addManageItem('My User Item', $this->urlForAction($method = 'index'), $orderId = 30);
      }
  }
  Download

  That’s it. This will add a menu item named “My User Item” to the “Manage” section of the user menu. When a user chooses the menu item, the “index” method of your controller will be executed and your previously created page will be first rendered and then displayed. Optionally, you can define an order to influence the position of the menu item within the manage section. Following this example you can add an item to any menu for any action. I think you get the point!

  

  Note: In Piwik 2.6.0 and before the above example would look like this:

  class Menu extends \Piwik\Plugin\Menu
  {
      public function configureUserMenu(MenuUser $menu)
      {
          $menu->addManageItem('My User Item', array($module = 'MyControllerPlugin', $action = 'index'), $orderId = 30);
      }
  }
  Download

  How to test a page

  After you have created your page you are surely wondering how to test it. A controller should be usually very simple as it is only the connector between model and view. Therefore, we do usually not create unit or integration test for controllers and for the view less than ever. Instead we would create a UI test that takes a screenshot of your page and compares it with an expected screenshot. Luckily, there is already a section UI tests in our Automated tests guide.

  Publishing your Plugin on the Marketplace

  In case you want to share your page 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.

  Advanced features

  Isn’t it easy to create a page? We never even created a file! Of course, based on our API design principle “The complexity of our API should never exceed the complexity of your use case.” you can accomplish more if you want: You can make use of Vanilla JavaScript, jQuery, AngularJS, Less and CSS, you can reuse UI components, you can access query parameters and much more.

  Would you like to know more about this? Go to our MVC (Model-View-Controller) and Working with Piwik’s UI guides in the Piwik Developer Zone.

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