Download the PHP package vinou/site-builder without Composer

On this page you can find all versions of the php package vinou/site-builder. 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?

Example code of vinou/site-builder

Informations about the package site-builder

Vinou Site-Builder

The Vinou Site-Builder is a PHP library that easily combine a basic php routing configured in a routes.yml file with Twig template rendering. The library also provides the possible to call libraries as data processors and pipe the result directly within the twig template.

Table of contents

Typical project structure

File Description
composer.json Main composer configuration to combine the whole site into one package
config/settings.yml All settings regarding SiteBuilder and ApiConnector
config/routes.yml All routes that are dynamically generated and rendered via sitebuilder
config/mail.yml Mail settings including smtp credentials
web/index.php Main instatiation
web/.htaccess Htaccess configuration mainly to link all requests to index.php
web/Resources/Layouts Layout folder
web/Resources/Layouts/Default.twig Default Twig-Layout
web/Resources/Partials optional Partials Folder
web/Resources/Templates/start.twig Template for start page

This example project structur can be found inside the repository in the Example/Project folder

Installation (via typical project structure)

This installation guide is based on our preferred project structure. This structure is developed over years and adopted from many OSS projects. Special thanks are going to the great TYPO3 community that we are participating over years and delivers a great knowhow and share ideas over years.

1. Setup project structure

2. Modify your installation

Required modifications!

Optional but typical modifications

Route configuration

1. General route parameters

Parameter Default Options Description
type page page generate page from twig template
redirect redirect to external or internal page
method get get page is only callable via GET requests
post page is only callable via POST requests
all page is callable by each type of http requests
template not set Path/to/template.twig template file to be used for this page
redirect not set /route/to/local/page local page for redirect
http://www.google.de you can also use URLs for redirect
pageTitle not set Start page Title of page shown in title tag and used as variable in template
public true true Page always callable
false Page only callable with Vinou client login
sitemap false true Page listed in sitemap.xml
false Page not listed in sitemap.xml
Array Array of options to generate sitemap entries see sitemap paramaters
twig not set Array Array of options that modify twig behaviour
dataProcessing not set Array Array of keys that are filled with the result of called functions

2. Load sitemap configuration for route

PLEASE NOTICE: to use sitemap parameters your route must contain a variable placeholder

Parameter Value (Example) Description
function getWinesAll function name in Vinou API-Connector that is called to fetch items
params Array Array of params that are piped into the sitemap renderer
params/lazy Boolean load entries recurring, can be useful if huge data is loaded
params/pageSize Integer number of entries loaded in one recurring process
dataKey wines Key in API result that contains the entries to generate different pages

3. Use dataProcessing

The main principle is that you can define a key that is filled by the result of the function that is called within a specific processor. If no processor is set the Vinou API-Connector is used by default.

SHORTHAND NOTICE: If you don't need any additional function configuration and want to call an API-Connector function you can define a key directly with the function name

Example shorthand calls for wines and wineries

Example advanced config to combine wines and bundles into one items array

Parameter Value (Example) Description
processor formatter identifier of processor where class is registered (see processor list)
class \Vendor\Namespace\Class use namespace call to load a class as a processor
function getWinesAll function name in Vinou API-Connector that is called to fetch items
params Array Array of params that are piped into the function
useRouteData Boolean Set to false is wildcard variables from route should not be piped into the function
useData Array Array of keys that are processed in the same dataProcessing before and should be piped into the function
dataKey wines Key in API result that contains the result
getParams firstname,lastname comma separated names of GET variables that should be piped into the function
postParams firstname,lastname comma separated names of POST variables that should be piped into the function

4. Registered processors

identifier Class API available in Processor Description
default \Vinou\ApiConnector\Api no Basic Vinou API calls
shop \Vinou\SiteBuilder\Processors\Shop yes Basic Shop functions combined with Vinou API
mailer \Vinou\SiteBuilder\Processors\Mailer yes Send mails from template forms
files \Vinou\SiteBuilder\Processors\Files no Read local files with meta data
external \Vinou\SiteBuilder\Processors\External no Load URLs, external files e.g. JSON files
sitemap \Vinou\SiteBuilder\Processors\Sitemap no Generate sitemaps
formatter \Vinou\SiteBuilder\Processors\Formatter no Combine and format loaded data

5. Register your own processor

Create your own processor

Go to your index.php and load the processor before SiteBuilder instantiation

Than use your processor directly in your route config

Classlist

Class Description
\Vinou\SiteBuilder\Site Main class of Sitebuilder that combines router and renderer
\Vinou\SiteBuilder\Loader\Settings Loading class to collect settings yaml files and load it into an array
\Vinou\SiteBuilder\Tools\Render Renderer that inits twig, delivers some twig filter and do the variable fill in stuff including data processing
\Vinou\SiteBuilder\Router\DynamicRoutes Read yaml files and configure bramus router with this yaml and do rendering
\Vinou\SiteBuilder\Processors\AbstractProcessor Abstract processor to easily use api in processor

Provider

This Library is developed by the Vinou GmbH.

Vinou GmbH
Mombacher Straße 68
55122 Mainz
E-Mail: [email protected]
Phone: +49 6131 6245390

All versions of site-builder with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
bramus/router Version *
twig/twig Version 2.*
twig/extensions Version 1.*
mustangostang/spyc Version ^0.5.1
erusev/parsedown Version ^1.7
phpmailer/phpmailer Version ^6.0
s1syphos/php-simple-captcha Version ^2.3
thepixeldeveloper/sitemap Version ^5.1
gumlet/php-image-resize Version ^1.9
vinou/api-connector Version ^3.0.0
vinou/translations Version 3.*
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 vinou/site-builder contains the following files

Loading the files please wait ....