Download the PHP package script-development/kendo-report-tool without Composer

On this page you can find all versions of the php package script-development/kendo-report-tool. 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 kendo-report-tool

kendo-report-tool

Packagist Version CI

Laravel client library for submitting user reports/feedback into a kendo project — config, Bearer auth, multipart image upload, and a surfaced send result, installable via Composer across Script Development Laravel territories.

Why

kendo ships a reports endpoint (POST /api/projects/{project}/reports) that accepts machine submissions authenticated with a report:create project token. This library is the secure server-side transport: a consuming app's backend holds the token (which must never ship to the browser) and relays a report — title, description, optional author name, optional screenshots — from the app's own feedback form into the kendo project.

Unlike kendo-error-tracker (auto-captured, fire-and-forget exception telemetry), a report is an explicit human submission: the send is synchronous and its outcome is surfaced, so the app can tell the user whether it sent.

Installation

The KendoReportToolServiceProvider is auto-discovered via Laravel package discovery. Publish the config if you want to tune it:

Configuration

Set the environment variables (the config reads REPORT_TOOL_*):

Env var Config key Description
REPORT_TOOL_KENDO_URL kendo_url Base URL of your kendo tenant — https://{tenant}.kendo.dev.
REPORT_TOOL_PROJECT project The kendo project id that owns the reports (the {project} route-key; kendo binds it by id).
REPORT_TOOL_TOKEN token A kendo project token carrying the report:create ability (Bearer).
REPORT_TOOL_CONNECT_TIMEOUT connect_timeout Seconds to wait while connecting to the kendo host (default 2).
REPORT_TOOL_TIMEOUT timeout Total seconds to wait for the POST (default 5).
REPORT_TOOL_SWALLOW swallow false (default) surfaces a failed send to the caller; true swallows it (telemetry mode).

Preconditions

Minting a project token

  1. Open the kendo project's API token settings.
  2. Create a project token — it carries the report:create ability.
  3. Copy the token into REPORT_TOOL_TOKEN.

A submission made with a report:create token is recorded with source = Api; the human author you pass is surfaced via author_name (the token owner is not treated as the creator).

Usage

Resolve KendoReports from the container and call submit():

Signature

submit() POSTs a multipart request to {kendo_url}/api/projects/{project}/reports with the Bearer report:create token, then:

A null author is omitted from the request rather than sent as an empty part.

Attaching screenshots

Pass $files as a list of Illuminate\Http\UploadedFile instances (e.g. straight from a feedback-form request) or local file paths. Each becomes a files[] multipart part:

The server accepts up to 5 image files (jpg/jpeg/png/bmp/gif/tiff/webp, ≤3 MB each). The client enforces the count (KendoReports::MAX_FILES): a call with more files is refused before anything is sent, with a ReportSubmissionException whose errors() is keyed by files. It also enforces the size (KendoReports::MAX_FILE_BYTES, 3,072,000 bytes — the server's 3mb) and refuses a path that is not a readable file, keyed by files.{index}; a file is sized before it is read, so an oversized one never enters memory. The type is checked by the server.

Surfaced failure vs. swallow

Because a report has a human waiting on confirmation, submit() surfaces a failed send by default (swallow=false) so the app can tell the user it did not send — contrast kendo-error-tracker, which always swallows. Catch the exception to drive UX:

The exception tells the failure classes apart:

$e->status() $e->errors() Meaning
422 field-keyed, e.g. ['title' => [...]] The payload was invalid — fix the input and resubmit.
0 ['files' => [...]] Too many files; refused locally, nothing was sent.
0 ['files.1' => [...]] That file is over MAX_FILE_BYTES or not a readable file; refused locally, nothing was sent.
401 / 403 [] The token or project setup is wrong — an operations problem, no resubmission fixes it.
5xx [] kendo failed; a later retry may succeed.
0 [] Transport failure (timeout, unreachable host).

A missing or malformed kendo_url, project or token throws ScriptDevelopment\KendoReportTool\Exceptions\ReportConfigurationException before anything is sent — also when swallowing, because a deployment that can never send is not a failed send. It is not a ReportSubmissionException.

Set REPORT_TOOL_SWALLOW=true to flip to telemetry-style swallow-on-failure (logs to error_log, returns null) when you do not want the caller to handle failures.

Contributing

CI runs, on PHP 8.4 and 8.5: composer validate --strict · composer audit · composer format:check · composer phpstan · composer test:coverage (the Pest suite with a coverage floor). Run those to reproduce CI locally; composer test and composer format are convenience scripts no workflow runs. main is always release-ready; PRs update CHANGELOG.md under [Unreleased].


All versions of kendo-report-tool with dependencies

PHP Build Version
Package Version
Requires php Version ^8.4
illuminate/contracts Version ^11.0 || ^12.0 || ^13.0
illuminate/support Version ^11.0 || ^12.0 || ^13.0
illuminate/http Version ^11.0 || ^12.0 || ^13.0
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 script-development/kendo-report-tool contains the following files

Loading the files please wait ...