Download the PHP package vskstudio/takt-symfony without Composer

On this page you can find all versions of the php package vskstudio/takt-symfony. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package takt-symfony

takt-symfony

📚 Documentation: taktlytics.com/docs/wrappers/symfony

Symfony bundle for Takt analytics. It wires the Takt snippet into your templates through a {{ takt() }} Twig function and exposes an autowired Takt service for server-side events.

Installation

If you use Symfony Flex, the bundle is enabled automatically. Otherwise add it manually to config/bundles.php:

Configuration

Create config/packages/takt.yaml:

The api_key must be ingest-scoped and domain-bound. Keep it out of source control via an environment variable.

script_origin is the first-party origin to serve the tracker + derive the endpoint from ({origin}/api/event): your Takt domain or a custom domain you proxy through to dodge ad-blockers (endpoint wins over it).

endpoint is where events are collected. It feeds two code paths at once: the browser snippet, which needs the full collect URL, and the server-side sender, which needs the origin it appends /api/event to. So both forms are accepted and normalised for you. These two settings are equivalent:

A value carrying any other path is taken as the collect URL verbatim, which is what a same-origin first-party proxy needs (endpoint: '/collect'). Leave it out to talk to the hosted Takt service. Takt is a managed service hosted in Europe; only the /takt.js measurement script can be served from your own domain (see mode: asset and script_origin).

takt-core-php 0.7 refuses every endpoint that is not https, localhost included, so the endpoint must be an https URL even in local development: endpoint: 'http://localhost:8000' makes the takt() snippet and the autowired Takt service throw an InvalidArgumentException when they are built, which breaks the page render. Serve your local collector over https, or point endpoint at an https origin.

Autocapture is opt-in. outbound, files, tagged and not_found each add a token to the single data-auto attribute read by the bundled tracker; file_extensions narrows which downloads count.

The advanced options map to the engine's sampleRate, trackQuery, queryParams, respectDnt and enabled. exclude maps to the engine's exclude (path prefixes never tracked) and, like scrub_url, only works in mode: sdk. scrub_url is a raw JS function injected verbatim, so it only works in mode: sdk (a full ES-module init() render). Keep it dev-controlled and never build it from user input.

Client-side tracking

Call the takt() Twig function inside the <head> of your base template:

Modes

Server-side events

Autowire the Takt service in any controller or service:

The autowired service is bound to the current request: it automatically attributes events to the request's IP address and User-Agent. It is deliberately not a shared service. A fresh instance is built on each injection so the attribution never outlives the request, including under long-running runtimes (FrankenPHP worker mode, RoadRunner).

Route redaction

Query strings are stripped by default, but path segments are sent as they are: /verify/abc123 leaks the token. Two opt-in settings replace real paths with route templates, in the snippet and in server-side events alike. In the snippet both require mode: sdk: the minimal snippet of the other modes cannot honor them, so the SnippetRenderer throws.

redact_routes lists the sensitive routes. A matching path is sent as the pattern, every other path keeps its real value. Patterns accept the Symfony syntax ({token}, {page?}) as well as [param], [[optional]], [...rest], :param, :param?, *, **, *name, :name* and :name+. The browser SDK reads {token} as [token], so a browser pageview reports /verify/[token] where a server event reports /verify/{token}; write /verify/[token] if both must land on the same row.

A parameter can carry a regex constraint, {id<\d+>}, which must match the whole segment (case-insensitively). The regex follows a restricted grammar, the same in the PHP and JavaScript SDKs: alternation only at the top level, literals, ., \d \D \w \W \s \S, escaped ASCII punctuation, classes [...] without nesting, and quantifiers bounded to 100. Groups, lookarounds, backreferences, anchors and / are refused, and the grammar counts bytes, not characters. A constrained parameter keeps its brace form in the browser, so the browser needs an SDK that reads that form to enforce the constraint. A route is unusable when one of its constraints is refused, when its constraints hold more than two variable quantifiers in total, when one segment holds more than one constrained parameter or more than two variable quantifiers, when its ambiguity degree exceeds one (/{a}{b}/{c}{d} is refused, /{a}{b}/{c} is accepted), or when it holds more than one REST segment (**, *name, :name*, :name+ or [...name]). An unusable route masks, as /[redacted], every path with the same shape; other paths are unaffected.

A path that cannot be decoded (a malformed escape such as %ZZ, or invalid UTF-8 once decoded) is masked as /[redacted] while a route is configured. Set redact_undecodable_paths: false to match such a path like any other on server-side events: it is then sent as the template it matches, and raw only when no route matches. The browser snippet keeps masking it, since the browser SDK has no such option.

route_templates sends every page as its route path: /users/42 becomes /users/{id}. The bundle resolves the _route of the main request through the router (Route::getPath(), inline requirements and defaults stripped), renders it into the takt() snippet and uses it as the default route of every pageview() and event() sent by the autowired Takt service. It suits fully private apps; on a public site it merges every article into one row. A request with no matched route keeps its real path, still subject to redact_routes. Resolving a route path loads the router's route collection, so this mode costs a little on each request.

Any server-side call can pick its own route template:

Registered services

Service Visibility Notes
Vskstudio\Takt\Takt public, not shared Autowired sender for server-side events; rebuilt per injection.
Vskstudio\Takt\SnippetRenderer public, shared Renders the snippet; backs the takt() Twig function.
Vskstudio\Takt\Options private, shared Built from the bundle config, injected into the renderer.
…\Twig\TaktTwigExtension public, shared Tagged twig.extension, exposes the takt() function (HTML-safe).
…\Symfony\RouteTemplate private, shared Registered only with route_templates: true; resolves the current route path.

Behind a proxy or load balancer? The attributed IP comes from Request::getClientIp(). It only honours X-Forwarded-For when the request is trusted, so configure framework.trusted_proxies for the real client IP. Without trusted proxies, clients can spoof the forwarded header. So never treat the attributed IP as authoritative.

License

MIT: see LICENSE.


All versions of takt-symfony with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
vskstudio/takt-core-php Version ^0.7.3
symfony/framework-bundle Version ^6.4 || ^7.0
symfony/http-client Version ^6.4 || ^7.0
nyholm/psr7 Version ^1.8
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package vskstudio/takt-symfony contains the following files

Loading the files please wait ...