Download the PHP package dezull/help-bundle without Composer

On this page you can find all versions of the php package dezull/help-bundle. 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 help-bundle

DezullHelpBundle

Help/Documentation bundle for Symfony2

Incompatible with Symfony 2.1.x

This bundle provides interface for viewing web application's documentation or help browser. The administration backend will allow users to manage documentation content. The included frontend template use two-pane layout to show help topics & content.

Dependencies

  1. symfony/framework-bundle
  2. doctrine/common
  3. symfony/doctrine-bundle
  4. TrsteelCkeditorBundle (Optional)

Installation

Using deps file

1. Add the bundle to deps

[DezullHelpBundle]
    git=git://github.com/dezull/HelpBundle.git
    target=/bundles/Dezull/Bundle/HelpBundle

2. Install vendor

$ php bin/vendors install

3. Add the bundle to app/AppKernel.php

$bundles = array(
    ...
    new Dezull\Bundle\HelpBundle\DezullHelpBundle(),
    ...
);

4. Add namespace to app/autoload.php

$loader->registerNamespaces(array(
    ...
    'Dezull' => __DIR__.'/../vendor/bundles',
    ...
));

5. Add routes. Customize to suite your application.

# This is the only required route need
DezullHelpBundle:
    prefix: /prefix
    resource: "@DezullHelpBundle/Resources/config/routing/main.yml"

_help_topic:
    type:     annotation
    pattern: /help/!{title}
    defaults: { _controller: DezullHelpBundle:Browser:index }

6. Install required tables into database, for example:

CREATE TABLE help_category (id INT AUTO_INCREMENT NOT NULL, name VARCHAR(120) NOT NULL, PRIMARY KEY(id)) ENGINE = InnoDB;
CREATE TABLE help_topic (id INT AUTO_INCREMENT NOT NULL, category_id INT DEFAULT NULL, title VARCHAR(120) NOT NULL, content LONGTEXT NOT NULL, INDEX IDX_FAD81EE212469DE2 (category_id), PRIMARY KEY(id)) ENGINE = InnoDB;
ALTER TABLE help_topic ADD CONSTRAINT FK_FAD81EE212469DE2 FOREIGN KEY (category_id) REFERENCES help_category(id);

Using composer.json

1. Add the bundle to composer.json

"require": {
    ...,
    "dezull/help-bundle": "1.0.1"
},

2. Update the dependencies

$ composer.phar update

Usage

  1. Use the admin interface to add new a category and topics. For example, access it via http://example.com/admin/help/category
  2. To link to the help page, use route to DezullHelpBundle:Browser:Index with topic title as its only parameter. For example, http://example.com/help/!How+to+use+this+web+app

All versions of help-bundle with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.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 dezull/help-bundle contains the following files

Loading the files please wait ....