PHPackages serwisant/serwisant-cp - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Admin Panels](/categories/admin) 4. / 5. serwisant/serwisant-cp ActiveLibrary[Admin Panels](/categories/admin) serwisant/serwisant-cp ====================== Customer Panel for https://serwisant.online service 1.6.2(6mo ago)0273Apache-2.0PHPPHP >=7.4CI failing Since Oct 8Pushed 6mo ago1 watchersCompare [ Source](https://github.com/SerwisantOnline/serwisant-cp-php-sdk)[ Packagist](https://packagist.org/packages/serwisant/serwisant-cp)[ Docs](https://github.com/SerwisantOnline/serwisant-cp-php-sdk)[ RSS](/packages/serwisant-serwisant-cp/feed)WikiDiscussions master Synced today READMEChangelogDependencies (12)Versions (33)Used By (0) Serwisant Online Customer Panel PHP SDK ======================================= [](#serwisant-online-customer-panel-php-sdk) This package contains complex customer panel application including PHP code, GraphQL queries, Twig templates and CSS/JS assets. Backend application is based on [Silex micro-framework](https://web.archive.org/web/20200813150217/https://silex.symfony.com/doc/2.0/) Layout is powered by [Bootstrap](https://getbootstrap.com/) and jQuery with additional libraries. Whole application is Apache licenced. Requirements: ------------- [](#requirements) - PHP 7.4 or higher + json, openssl, curl extensions ### Optional: [](#optional) - MySql/MariaDB server + PHP pdo extensions (caching) ### development/deploy requirements [](#developmentdeploy-requirements) - composer (to install PHP dependencies) - node 14.x or higher and NPM (to build assets) Word about versioning --------------------- [](#word-about-versioning) This is special package. Because it contains complex application we can't provide long term backward compatibility. There is high risk of implementing breaking changes once new features will be added. Version numbering scheme is `x.y.z` where `x` is main version. `y` is 'feature' version, and it will change when new major features are added to application. `z` id bugfix version, and it will change when non-significant bugfixes are made. So when you're building own application, with custom modifications of templates, assets, logic ***please specify explicite version*** in your `composer.json` i.e.: `"1.0.0"`. If you can specify `1.0.*` to gets bugfixes, but if `y` version will be increased bugfixes will be shipped into new major version. If you're installing this application it as-is, and no modification will be made, you can include major version `1.*`, to get upgrades. ***YOU HAVE BEING WARNED.*** - no support will be given because of version changes. Usage ----- [](#usage) ### Typical files layout [](#typical-files-layout) You should create basic directory and files tree. ``` |--/public | /public/.htaccess | /public/index.php | |--/composer.json |--/package.json ``` `public` must be root of your webserver. In this directory yoy must create two other files: `index.php` (see Bootstrap section) and `.htaccess` (see Webserver configuration section). Please note: two otger directories will be created there when you will build assets. `composer.json` is a PHP dependency configuration. You need a `composer` tool to install it. `package.json` is a frontend dependency configuration. Tou need a `npm` tool to install it. See Assets section. ### PHP dependencies [](#php-dependencies) To install all required dependencies for your web application you must create a file `composer.json`: ``` { "name": "my_application", "require": { "serwisant/serwisant-cp": "1.*" }, "autoload": { "psr-0": { "Serwisant": "src" } } } ``` Once file is created run `composer install`. It will produce a `vendor` directory with many subdirectories and files inside. ### Assets (JS, CSS, images) [](#assets-js-css-images) Application contains complex assets to provide a frontend layout via CSS and functionality via JS. Also, those assets have some dependencies from other JS libraries. To get frontend working you must create `package.json`: ``` { "name": "My Application", "private": true, "scripts": { "postinstall": "node vendor/serwisant/serwisant-cp/npm-package/build.js" }, "dependencies": { "serwisant-cp": "file:vendor/serwisant/serwisant-cp/npm-package" } } ``` and run `npm install`. Once all JS dependencies are installed additional script will run, and will generate a files in `public/assets-serwisant-cp` and `public/webfonts`. ***Please note: JS dependencies must be installed after PHP dependencies.*** Please note: once you'll install all JS dependencies, you can remove whole `node_modules` directory before you start upload files to webserver, because all required files has being moved into other directory. ### Server configuration [](#server-configuration) If you have access to shell on webserver and `composer`/`npm` tools are installed there you can send a basic files and run installation (composer and npm) directly on webserver. Most important when configuring hosting or webserver thing is to set your webserver to `public` subdirectory, not to root directory. It's for security reasons. Don't forget to override apache/nginx config to point every single request to your `index.php`. It can be done with a `.htaccess` file: ``` RewriteEngine On RewriteBase / RewriteRule ^index\.php$ - [L] RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-d RewriteRule . /index.php [L] ``` ### Bootstrap [](#bootstrap) Typical, minimal application's bootstrap looks like below. ``` $oauth_key = 'YOUR_OAUTH_KEY'; $oauth_secret = 'YOUR_OAUTH_SECRET'; require_once('./vendor/autoload.php'); use Serwisant\SerwisantCp; use Serwisant\SerwisantApi; $application = new SerwisantCp\Application(); $application->set('access_token_public', new SerwisantApi\AccessTokenOauth( $oauth_key, $oauth_secret, 'public', new SerwisantApi\AccessTokenContainerEncryptedFile(sha1($oauth_key)) )); $application->set('access_token_customer', new SerwisantApi\AccessTokenOauthUserCredentials( $oauth_key, $oauth_secret, 'customer', new SerwisantApi\AccessTokenContainerSession() )); $application->setRouter(new SerwisantCp\ApplicationRouter()); $application->run(); ``` #### $application->set('access\_token\_public',... [](#application-setaccess_token_public) Public access token is stored in encrypted local file via `AccessTokenContainerEncryptedFile`. By default system `/tmp`is used for that purpose. You can change TMP dir for whole module by setting a `TMPDIR` env variable, i.e.: ``` putenv('TMPDIR=' . realpath('/path/to/tmp/dir')); ``` If you running application in distributed, multi-server environment, or you want to increase performance use SQL database container: ``` new SerwisantApi\AccessTokenContainerPDO(['mysql:dbname=db;host=127.0.0.1', 'user', 'password']) ``` Public access token is common for all users - it's generated in first request, cached and re-used by other users. #### $application->set('access\_token\_customer',... [](#application-setaccess_token_customer) Customer access token is kept in session. You can keep it into other storage, but you must remember that a customer access token is user specific, each logged in customer has its own token related to username/password. Session store by default will use files in global, system temporary folder. You can configure own session store, i.e. database in bootstrap file. See section with advanced topics. #### $application->setRouter(... [](#application-setrouter) This is default path/routes set. If you want to create own pages or change prefix paths create a new router by extending `Router`. By default, you need to mount standard application routes. Advanced topics, modifying application -------------------------------------- [](#advanced-topics-modifying-application) First of all. ***Don't modify/edit any part of code from module directly***. If version will change, and you'll be forced tu update - all your edits will disappear, and you'll need to re-implement it. Application have some features, that allow to apply modifications without touching internal code. If you can't use those additional features, or you want to modify code directly, fork GitHub repository, implement your changes, and use private composer module instead this from packagist.org. ### Custom views and translations [](#custom-views-and-translations) By default all views are stored inside of `views/` folder and translations in `translations/` inside of module. You can overwrite views and translations, also you can add your own language translations. When initializing application in bootstrap file, pass additional paths to directories from your application. For views: put in configured folder files with the same names as original view. Your custom files will take priority over original views. It's strongly recommended to do not create custom views from a scratch. Copy original view to your custom folder and tune it. For translations: prepare additional translation in your language - you should use `translations/pl.yml` as base. Then put new file in application directory and add to argument. Application will detect all available translations, and will serve it using customer browser language settings. If no translation is available, default can be used. ``` $application = new SerwisantCp\Application('production', ["./views"], [], ["./translations/en.yml", "./translations/de.yml"], 'en_GB'); ``` Arguments: - environment, use `production` - array of directories (full paths) with alternate views - (not a scope of this documentation) - array of translation files - default translation, if none match ### Custom modifiers [](#custom-modifiers) Overwrite logic related to location/translation detection, including translations, timezones, etc. Extend original class to use static language and use it with `set` method. ``` class LocaleDetector extends \Serwisant\SerwisantCp\LocaleDetector { public function __construct() { $this->default_locale = 'pl_PL'; $this->locale = 'pl_PL'; $this->country = (new \PragmaRX\Countries\Package\Countries())->where('cca2', explode('PL')->first(); } } $application->set('locale_detector', new LocaleDetector()); ``` You can use database session-store - pass new instance of PdoSessionHandler supplied with proper arguments with database credentials. ``` $application->set('session_handler', new \Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler(...)) ``` ### Health Score 39 — LowBetter than 85% of packages Maintenance66 Regular maintenance activity Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity62 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~49 days Recently: every ~70 days Total 32 Last Release 201d ago PHP version history (2 changes)1.0.0PHP >=7.2 1.0.1PHP >=7.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/c133733b9dc4349ccd002631b60c013bbb0beea2bcb973f6c80ff4a49424ab7d?d=identicon)[arekk](/maintainers/arekk) --- Top Contributors [![arekk](https://avatars.githubusercontent.com/u/992535?v=4)](https://github.com/arekk "arekk (128 commits)") --- Tags composerpackagephpserwisant ### Embed Badge ![Health badge](/badges/serwisant-serwisant-cp/health.svg) ``` [![Health](https://phpackages.com/badges/serwisant-serwisant-cp/health.svg)](https://phpackages.com/packages/serwisant-serwisant-cp) ``` ### Alternatives [easycorp/easyadmin-bundle Admin generator for Symfony applications 4.3k17.9M388](/packages/easycorp-easyadmin-bundle)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.6M568](/packages/shopware-core)[shopware/platform The Shopware e-commerce core 3.4k1.5M3](/packages/shopware-platform)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.4M203](/packages/sulu-sulu)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k5.9M733](/packages/sylius-sylius)[oro/platform Business Application Platform (BAP) 645143.5k114](/packages/oro-platform) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)