PHPackages jackalope/jackalope-prismic - 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. [Database & ORM](/categories/database) 4. / 5. jackalope/jackalope-prismic AbandonedArchivedLibrary[Database & ORM](/categories/database) jackalope/jackalope-prismic =========================== Jackalope Transport library for http://prismic.io DBAL 57[9 issues](https://github.com/jackalope/jackalope-prismic/issues)PHP Since Apr 21Pushed 3mo ago5 watchersCompare [ Source](https://github.com/jackalope/jackalope-prismic)[ Packagist](https://packagist.org/packages/jackalope/jackalope-prismic)[ RSS](/packages/jackalope-jackalope-prismic/feed)WikiDiscussions master Synced today READMEChangelogDependenciesVersions (2)Used By (0) Abandoned ========= [](#abandoned) This package is not maintained. Please use the maintained PHPCR implementations [jackalope-doctrine-dbal](https://github.com/jackalope/jackalope-doctrine-dbal) or [jackalope-jackrabbit](https://github.com/jackalope/jackalope-jackrabbit). Jackalope [![Build Status](https://camo.githubusercontent.com/b9ba2b9bdb40676d6ea494f95ff2b47c022da26aa6732a182600d9c19e270572/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f6a61636b616c6f70652f6a61636b616c6f70652d707269736d69632e706e673f6272616e63683d6d6173746572)](http://travis-ci.org/jackalope/jackalope-prismic) ======================================================================================================================================================================================================================================================================================================================================= [](#jackalope-) Implementation of the PHP Content Repository API ([PHPCR](http://phpcr.github.io)) using a relational database to persist data. Jackalope-prismic uses the service for storage. For the moment, it is less feature complete, performant and robust than [Jackalope-Jackrabbit](http://github.com/jackalope/jackalope-jackrabbit). Discuss on or visit #jackalope on irc.freenode.net License ------- [](#license) This code is dual licensed under the MIT license and the Apache License Version 2.0. Please see the file LICENSE in this folder. Preconditions ============= [](#preconditions) - php >= 5.3 - One of the following databases, including the PDO extension for it: - MySQL >= 5.1.5 (we need the ExtractValue function) - PostgreSQL - SQLite Installation ============ [](#installation) The recommended way to install jackalope is through [composer](http://getcomposer.org/). You can of course do without, but then you will need to resolve the dependencies manually. ``` $ mkdir my-project $ cd my-project $ curl -s http://getcomposer.org/installer | php $ ./composer.phar init $ ./composer.phar require jackalope/jackalope-prismic $ ./composer.phar install ``` Create a repository ------------------- [](#create-a-repository) Create a login on and follow the instructions there. Enable the commands ------------------- [](#enable-the-commands) There are a couple of useful commands to interact with the repository. To use the console, copy `cli-config.php.dist` to `cli-config.php` and configure the connection parameters. Then you can run the commands from the jackalope directory with `./bin/jackalope` NOTE: If you are using PHPCR inside of **Symfony**, the DoctrinePHPCRBundle provides the commands inside the normal Symfony console and you don't need to prepare anything special. You have many useful commands available from the phpcr-utils. To get a list of all commands, type: ``` $ ./bin/jackalope ``` To get more information on a specific command, use the `help` command. To learn more about the `phpcr:workspace:export` command for example, you would type: ``` $ ./bin/jackalope help phpcr:workspace:export ``` Bootstrapping ============= [](#bootstrapping) Jackalope relies on autoloading. Namespaces and folders are compliant with PSR-0. You should use the autoload file generated by composer: `vendor/autoload.php` If you want to integrate jackalope into other PSR-0 compliant code and use your own classloader, find the mapping in `vendor/composer/autoload_namespaces.php` Before you can use jackalope with a database, you need to set the database up. Create a database as described above, then make sure the command line utility is set up (see above "Enable the commands"). Now you can run: ``` $ bin/jackalope jackalope:init:dbal ``` Once these steps are done, you can bootstrap the library. A minimalist sample code to get a PHPCR session with the prismic backend: ``` $uri = 'https://%s.prismic.io/api'; $workspace = 'lesbonneschoses'; // phpcr workspace to use $factory = new \Jackalope\RepositoryFactoryPrismic(); $repository = $factory->getRepository(array('jackalope.prismic_uri' => $uri)); // dummy credentials to comply with the API $credentials = new \PHPCR\SimpleCredentials(null, null); $session = $repository->login($credentials, $workspace); ``` Usage ===== [](#usage) The entry point is to create the repository factory. The factory specifies the storage backend as well. From this point on, there are no differences in the usage (except for supported features, that is). ``` // see Bootstrapping for how to get the session. $rootNode = $session->getNode("/"); ``` See [PHPCR Tutorial](https://github.com/phpcr/phpcr-docs/blob/master/tutorial/Tutorial.md)for a more detailed tutorial on how to use the PHPCR API. Performance tweaks ================== [](#performance-tweaks) Advanced configuration ====================== [](#advanced-configuration) Logging ------- [](#logging) Jackalope supports logging, for example to investigate the number and type of queries used. To enable logging, provide a logger instance to the repository factory: ``` $factory = new \Jackalope\RepositoryFactoryPrismic(); $logger = new Jackalope\Transport\Logging\DebugStack(); $options = array( 'jackalope.uri' => $uri, 'jackalope.logger' => $logger, ); $repository = $factory->getRepository($options); //... // at the end, output debug information var_dump($logger->calls); ``` You can also wrap a [PSR-3](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md)compatible logger like [monolog](https://github.com/Seldaek/monolog) with the Psr3Logger class. Note that when using jackalope in Symfony2, the logger is integrated in the debug toolbar. Implementation notes ==================== [](#implementation-notes) See [doc/architecture.md](https://github.com/jackalope/jackalope/blob/master/doc/architecture.md)for an introduction how Jackalope is built. Have a look at the source files and generate the phpdoc. Running the tests ================= [](#running-the-tests) Jackalope-prismic is integrated with the phpcr-api-tests suite that tests all PHPCR functionality. If you want to run the tests, please see the [README file in the tests folder](https://github.com/jackalope/jackalope-prismic/blob/master/tests/README.md). Things left to do ================= [](#things-left-to-do) The best overview of what needs to be done are the skipped API tests. Have a look at [ImplementationLoader](https://github.com/jackalope/jackalope-prismic/blob/master/tests/ImplementationLoader.php)to see what is currently not working and start hacking :-) Also have a look at the issue trackers of this project and the base jackalope/jackalope. Contributors ============ [](#contributors) - Christian Stocker - David Buchmann - Tobias Ebnöther - Roland Schilter - Uwe Jäger - Lukas Kahwe Smith - Benjamin Eberlei - Daniel Barsotti - [and many others](https://github.com/jackalope/jackalope-prismic/contributors) ### Health Score 28 — LowBetter than 54% of packages Maintenance35 Infrequent updates — may be unmaintained Popularity9 Limited adoption so far Community22 Small or concentrated contributor base Maturity43 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits 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. ### Community Maintainers ![](https://avatars.githubusercontent.com/u/20873?v=4)[Luke Smith](/maintainers/lsmith)[@lsmith](https://github.com/lsmith) --- Top Contributors [![dbu](https://avatars.githubusercontent.com/u/76576?v=4)](https://github.com/dbu "dbu (480 commits)")[![lsmith77](https://avatars.githubusercontent.com/u/300279?v=4)](https://github.com/lsmith77 "lsmith77 (445 commits)")[![beberlei](https://avatars.githubusercontent.com/u/26936?v=4)](https://github.com/beberlei "beberlei (97 commits)")[![ebi](https://avatars.githubusercontent.com/u/11541?v=4)](https://github.com/ebi "ebi (93 commits)")[![Seldaek](https://avatars.githubusercontent.com/u/183678?v=4)](https://github.com/Seldaek "Seldaek (73 commits)")[![lapistano](https://avatars.githubusercontent.com/u/95115?v=4)](https://github.com/lapistano "lapistano (63 commits)")[![cryptocompress](https://avatars.githubusercontent.com/u/1130433?v=4)](https://github.com/cryptocompress "cryptocompress (54 commits)")[![chregu](https://avatars.githubusercontent.com/u/47106?v=4)](https://github.com/chregu "chregu (49 commits)")[![rndstr](https://avatars.githubusercontent.com/u/32963?v=4)](https://github.com/rndstr "rndstr (46 commits)")[![nicam](https://avatars.githubusercontent.com/u/182071?v=4)](https://github.com/nicam "nicam (39 commits)")[![petesiss](https://avatars.githubusercontent.com/u/235621?v=4)](https://github.com/petesiss "petesiss (31 commits)")[![adou600](https://avatars.githubusercontent.com/u/1431387?v=4)](https://github.com/adou600 "adou600 (24 commits)")[![uwej711](https://avatars.githubusercontent.com/u/648874?v=4)](https://github.com/uwej711 "uwej711 (15 commits)")[![justinrainbow](https://avatars.githubusercontent.com/u/86520?v=4)](https://github.com/justinrainbow "justinrainbow (13 commits)")[![dantleech](https://avatars.githubusercontent.com/u/530801?v=4)](https://github.com/dantleech "dantleech (11 commits)")[![lex009](https://avatars.githubusercontent.com/u/1351919?v=4)](https://github.com/lex009 "lex009 (7 commits)")[![Toflar](https://avatars.githubusercontent.com/u/481937?v=4)](https://github.com/Toflar "Toflar (4 commits)")[![ApiciusPoulet](https://avatars.githubusercontent.com/u/5089333?v=4)](https://github.com/ApiciusPoulet "ApiciusPoulet (3 commits)")[![vdrnn](https://avatars.githubusercontent.com/u/58754?v=4)](https://github.com/vdrnn "vdrnn (3 commits)")[![ornicar](https://avatars.githubusercontent.com/u/140370?v=4)](https://github.com/ornicar "ornicar (3 commits)") ### Embed Badge ![Health badge](/badges/jackalope-jackalope-prismic/health.svg) ``` [![Health](https://phpackages.com/badges/jackalope-jackalope-prismic/health.svg)](https://phpackages.com/packages/jackalope-jackalope-prismic) ``` ### Alternatives [doctrine/orm Object-Relational-Mapper for PHP 10.2k285.3M6.2k](/packages/doctrine-orm)[jdorn/sql-formatter a PHP SQL highlighting library 3.9k115.1M102](/packages/jdorn-sql-formatter)[illuminate/database The Illuminate Database package. 2.8k52.4M9.4k](/packages/illuminate-database)[mongodb/mongodb MongoDB driver library 1.6k64.0M546](/packages/mongodb-mongodb)[ramsey/uuid-doctrine Use ramsey/uuid as a Doctrine field type. 90340.3M211](/packages/ramsey-uuid-doctrine)[reliese/laravel Reliese Components for Laravel Framework code generation. 1.7k3.4M16](/packages/reliese-laravel) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)