laminas-api-tools / statuslib-example
Library for use with Laminas API Tools documentation examples
Fund package maintenance!
Community Bridge
Installs: 4 781
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 10
Forks: 9
Open Issues: 6
Requires
- php: ^7.3 || ~8.0.0
- laminas-api-tools/api-tools-configuration: ^1.4
- laminas/laminas-config: ^3.4
- laminas/laminas-db: ^2.12
- laminas/laminas-hydrator: ^1.1 || ^2.0 || ^3.0 || ^4.0
- laminas/laminas-paginator: ^2.10
- laminas/laminas-stdlib: ^2.7.7 || ^3.0.1
- laminas/laminas-zendframework-bridge: ^1.0
- ramsey/uuid: ^2.8
Requires (Dev)
- laminas/laminas-coding-standard: ~2.3.0
Replaces
- zfcampus/statuslib-example: ^1.2.0
README
π·πΊ Π ΡΡΡΠΊΠΈΠΌ Π³ΡΠ°ΠΆΠ΄Π°Π½Π°ΠΌ
ΠΡ, ΡΡΠ°ΡΡΠ½ΠΈΠΊΠΈ Laminas, ΡΠΎΠ΄ΠΈΠ»ΠΈΡΡ ΠΈ ΠΆΠΈΠ²Π΅ΠΌ Π² ΡΠ°Π·Π½ΡΡ ΡΡΡΠ°Π½Π°Ρ . Π£ ΠΌΠ½ΠΎΠ³ΠΈΡ ΠΈΠ· Π½Π°Ρ Π΅ΡΡΡ Π΄ΡΡΠ·ΡΡ, ΡΠΎΠ΄ΡΡΠ²Π΅Π½Π½ΠΈΠΊΠΈ ΠΈ ΠΊΠΎΠ»Π»Π΅Π³ΠΈ ΠΊΠ°ΠΊ Π² Π ΠΎΡΡΠΈΠΈ, ΡΠ°ΠΊ ΠΈ Π² Π£ΠΊΡΠ°ΠΈΠ½Π΅. ΠΠ΅ΠΊΠΎΡΠΎΡΡΠ΅ ΠΈΠ· Π½Π°Ρ ΡΠΎΠ΄ΠΈΠ»ΠΈΡΡ Π² Π ΠΎΡΡΠΈΠΈ. ΠΠ΅ΠΊΠΎΡΠΎΡΡΠ΅ ΠΈΠ· Π½Π°Ρ ΠΆΠΈΠ²ΡΡ Π² Π ΠΎΡΡΠΈΠΈ. Π£ Π½Π΅ΠΊΠΎΡΠΎΡΡΡ Π±Π°Π±ΡΡΠΊΠΈ ΠΈ Π΄Π΅Π΄ΡΡΠΊΠΈ ΡΡΠ°ΠΆΠ°Π»ΠΈΡΡ Ρ ΡΠ°ΡΠΈΡΡΠ°ΠΌΠΈ Π²ΠΎ ΠΡΠΎΡΠΎΠΉ ΠΌΠΈΡΠΎΠ²ΠΎΠΉ Π²ΠΎΠΉΠ½Π΅. ΠΠ΄Π΅ΡΡ Π½ΠΈΠΊΡΠΎ Π½Π΅ ΠΏΠΎΠ΄Π΄Π΅ΡΠΆΠΈΠ²Π°Π΅Ρ ΡΠ°ΡΠΈΠ·ΠΌ.
Π£ ΠΎΠ΄Π½ΠΎΠ³ΠΎ ΠΈΠ· Π½Π°Ρ Π΅ΡΡΡ ΡΠΊΡΠ°ΠΈΠ½ΡΠΊΠ°Ρ ΡΠΎΠ΄ΡΡΠ²Π΅Π½Π½ΠΈΡΠ°, ΠΊΠΎΡΠΎΡΠ°Ρ ΡΠΏΠ°ΡΠ»Π°ΡΡ ΠΈΠ· Π΄ΠΎΠΌΠ° Π²ΠΌΠ΅ΡΡΠ΅ Ρ ΡΡΠ½ΠΎΠΌ. ΠΠΎΠ΅Π·Π΄ Π·Π°Π΄Π΅ΡΠΆΠ°Π»ΡΡ ΠΈΠ·-Π·Π° Π±ΠΎΠΌΠ±Π΅ΠΆΠΊΠΈ Π½Π° Π΄ΠΎΡΠΎΠ³Π΅ Π²ΠΏΠ΅ΡΠ΅Π΄ΠΈ. Π£ Π½Π°Ρ Π΅ΡΡΡ Π΄ΡΡΠ·ΡΡ, ΠΊΠΎΡΠΎΡΡΠ΅ ΠΏΡΡΡΡΡΡΡ Π² Π±ΠΎΠΌΠ±ΠΎΡΠ±Π΅ΠΆΠΈΡΠ°Ρ . ΠΡ Ρ ΡΡΠ΅Π²ΠΎΠ³ΠΎΠΉ ΠΆΠ΄Π΅ΠΌ Π²Π΅ΡΡΠΎΡΠΊΠΈ ΠΎΡ Π½ΠΈΡ ΠΏΠΎΡΠ»Π΅ Π²ΠΎΠ·Π΄ΡΡΠ½ΡΡ Π½Π°Π»Π΅ΡΠΎΠ², ΠΊΠΎΡΠΎΡΡΠ΅ Π±Π΅ΡΠΏΠΎΡΡΠ΄ΠΎΡΠ½ΠΎ Π½Π°Π½ΠΎΡΡΡ ΡΠ΄Π°ΡΡ ΠΈ ΠΏΠΎΠΏΠ°Π΄Π°ΡΡ ΠΏΠΎ Π±ΠΎΠ»ΡΠ½ΠΈΡΠ°ΠΌ, ΡΠΊΠΎΠ»Π°ΠΌ, Π΄Π΅ΡΡΠΊΠΈΠΌ ΡΠ°Π΄Π°ΠΌ ΠΈ Π΄ΠΎΠΌΠ°ΠΌ. ΠΡ Π½Π΅ Π±Π΅ΡΠ΅ΠΌ ΡΡΠΎ ΠΈΠ· ΠΊΠ°ΠΊΠΈΡ -Π»ΠΈΠ±ΠΎ Π‘ΠΠ. ΠΡ Π½Π°Π±Π»ΡΠ΄Π°Π΅ΠΌ ΡΡΠΎ Π½Π°ΠΏΡΡΠΌΡΡ.
ΠΡ Π΄ΠΎΠ²Π΅ΡΡΠ΅ΡΠ΅ Π½Π°ΠΌ Π΄ΠΎΡΡΠ°ΡΠΎΡΠ½ΠΎ, ΡΡΠΎΠ± ΠΈΡΠΏΠΎΠ»ΡΠ·ΠΎΠ²Π°ΡΡ Π½Π°ΡΠΈ ΠΏΡΠΎΠ³ΡΠ°ΠΌΠΌΡ, ΠΈ ΠΌΡ ΠΏΡΠΎΡΠΈΠΌ Π²Π°Ρ Π΄ΠΎΠ²Π΅ΡΠΈΡΡΡΡ Π½Π°ΠΌ Π²Π½ΠΎΠ²Ρ. ΠΡ Π½ΡΠΆΠ΄Π°Π΅ΠΌΡΡ Π² ΠΏΠΎΠΌΠΎΡΠΈ. ΠΡΡ ΠΎΠ΄ΠΈΡΠ΅ ΠΈ ΠΏΡΠΎΡΠ΅ΡΡΡΠΉΡΠ΅ ΠΏΡΠΎΡΠΈΠ² ΡΡΠΎΠΉ Π±Π΅ΡΠΏΠΎΠ»Π΅Π·Π½ΠΎΠΉ Π²ΠΎΠΉΠ½Ρ. ΠΡΡΠ°Π½ΠΎΠ²ΠΈΡΠ΅ ΠΊΡΠΎΠ²ΠΎΠΏΡΠΎΠ»ΠΈΡΠΈΠ΅. Π‘ΠΊΠ°ΠΆΠΈΡΠ΅ "ΠΠ΅Ρ Π²ΠΎΠΉΠ½Π΅!"
πΊπΈ To Citizens of Russia
We at Laminas come from all over the world. Many of us have friends, family and colleagues in both Russia and Ukraine. Some of us were born in Russia. Some of us currently live in Russia. Some have grandparents who fought Nazis in World War II. Nobody here supports fascism.
One team member has a Ukrainian relative who fled her home with her son. The train was delayed due to bombing on the road ahead. We have friends who are hiding in bomb shelters. We anxiously follow up on them after the air raids, which indiscriminately fire at hospitals, schools, kindergartens and houses. We're not taking this from any media. These are our actual experiences.
You trust us enough to use our software. We ask that you trust us to say the truth on this. We need your help. Go out and protest this unnecessary war. Stop the bloodshed. Say "stop the war!"
This is a library designed to demonstrate an Laminas API Tools "Code-Connected" REST API, and has been written in parallel with the Laminas API Tools documentation.
It uses the following components:
- rhumsaa/uuid, a library for generating and validating UUIDs.
- laminas-api-tools/api-tools-configuration, used for providing PHP files as one possible backend for reading/writing status messages.
- laminas/laminas-config for the actual configuration writer used
by the
api-tools-configuration
module. - laminas/laminas-db, used for providing a database table as a backend for reading/writing status messages.
- laminas/laminas-stdlib, specifically the Hydrator subcomponent,
for casting data from arrays to objects, and for the
ArrayUtils
class, which provides advanced array merging capabilities. - laminas/laminas-paginator for providing pagination.
It is written as a Laminas module, but could potentially be dropped into other
applications; use the StatusLib\*Factory
classes to see how dependencies might be injected.
Installation
Use Composer to install the library in your application:
$ composer require laminas-api-tools/statuslib-example
If you are using this as part of a Laminas or Laminas API Tools application, you
may need to enable the module in your config/application.config.php
file, if
you are not using the laminas-component-installer:
return [ /* ... */ 'modules' => [ /* ... */ 'StatusLib', ], /* ... */ ];
Configuration
When used as a Laminas module, you may define the following configuration values in order to tell the library which adapter to use, and what options to pass to that adapter.
[ 'statuslib' => [ 'db' => 'Name of service providing DB adapter', 'table' => 'Name of database table within db to use', 'array_mapper_path' => 'path to PHP file returning an array for use with ArrayMapper', ], 'service_manager' => [ 'aliases' => [ // Set to either StatusLib\ArrayMapper or StatusLib\TableGatewayMapper \StatusLib\Mapper::class => \StatusLib\ArrayMapper::class, ], ], ]
For purposes of the Laminas API Tools examples, we suggest the following:
-
Create a PHP file in your application's
data/
directory namedstatuslib.php
that returns an array:<?php return [];
-
Edit your application's
config/autoload/local.php
file to set thearray_mapper_path
configuration value todata/statuslib.php
:<?php return [ /* ... */ 'statuslib' => [ 'array_mapper_path' => 'data/statuslib.php', ], ];
The above will provide the minimum necessary requirements for experimenting with the library in order to test an API.
Using a database
The file data/statuslib.sqlite.sql
contains a SQLite schema. You can
create a SQLite database using:
$ sqlite3 statuslib.db < path/to/data/statuslib.sqlite.sql
The schema can be either used directly by other databases, or easily modified to work with other databases.
StatusLib in a New Laminas Project
- Create a new Laminas project from scratch; we'll use
my-project
as our project folder:
$ composer create-project laminas/skeleton-application my-project
- Install the StatusLib module:
$ composer require laminas-api-tools/statuslib-example
-
Build a DataSource
-
Option A: Array data source:
First, copy the sample array to the
data
directory of thet application:$ cp vendor/laminas-api-tools/statuslib-example/data/sample-data/array-data.php data/status.data.php
Then, configure this datasource by setting up a
local.php
configuration file:$ cp config/autoload/local.php.dist config/autoload/local.php
Next, add the StatusLib specific configuration for an array based data source:
'statuslib' => [ 'array_mapper_path' => 'data/status.data.php', ], 'service_manager' => [ 'aliases' => [ \StatusLib\Mapper::class => \StatusLib\ArrayMapper::class, ], ],
-
Option B: Sqlite data source:
First, create a sqlite3 database, and fill it with the sample data:
$ sqlite3 data/status.db < vendor/laminas-api-tools/statuslib-example/data/statuslib.sqlite.sql $ sqlite3 data/status.db < vendor/laminas-api-tools/statuslib-example/data/sample-data/db-sqlite-insert.sql
Then, configure this datasource by setting up a
local.php
configuration file:$ cp config/autoload/local.php.dist config/autoload/local.php
Next, add the StatusLib specific configuration for a sqlite database based data source:
'db' => [ 'adapters' => [ 'MyDb' => [ 'driver' => 'pdo_sqlite', 'database' => __DIR__ . '/../../data/status.db' ], ], ], 'statuslib' => [ 'db' => 'MyDb', 'table' => 'status', ], 'service_manager' => [ 'aliases' => [ \StatusLib\Mapper::class => \StatusLib\TableGatewayMapper::class, ], ],
-
-
Create a test script to prove the data source is working:
// test.php namespace StatusLib; use Laminas\Mvc\Application; use Laminas\Stdlib\ArrayUtils; include 'vendor/autoload.php'; $appConfig = include 'config/application.config.php'; if (file_exists('config/development.config.php')) { $appConfig = ArrayUtils::merge( $appConfig, include 'config/development.config.php' ); } $app = Application::init($appConfig); $services = $app->getServiceManager(); $statusMapper = $services->get(Mapper::class); foreach ($statusMapper->fetchAll() as $status) { printf( "[%d] [%s] %s (by %s)\n", $status->timestamp, $status->id, $status->message, $status->user ); }