Download the PHP package phalcana/userguide without Composer

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

Informations about the package userguide

Latest Stable Version Build Status Total Downloads License

Phalcon Userguide Module

Userguide module for the Phalcana project based on the one for Kohana.

Installation

This module is installed by default with the Phalcana project by composer when dev modules are included for more information see the Phalcana Project.

In order for the module to be loaded into Phalcana the module needs to be added into the modules config. This can be found in the app/config/static.php or in the local version app/config/setup.php. For example.

Basic Usage

Once the module is sucessfully installed you can access it in your project by accessing the URL at /guide.

Adding To The Guide

Files for the guide are added inside each module and the system folder in guide/module-name. Files added are added in the Markdown syntax. See below about Markdown for more info.

The homepage for each module should be name index.md and the menu structure to connect the files together should be added in a menu.md file.

API Browser

The user guide also contains an API browser assembled from DOC blocks within the code. This works much the same as PHPDocumentor and is organised by using the main class DOC blocks sorting first by @package then by @category. Code blocks use Markdown to format documentation for the class and each individual function. For more details on the Markdown syntax please see below.

Markdown

Most of the markdown parsing is handled by PHP Markdown. For detailed information please visit the documentation. There are modifications that allow rewriting of local links

All versions of userguide with dependencies

PHP Build Version
Package Version
Requires phalcana/installer Version ^0.8
phalcana/core Version ^0.8
michelf/php-markdown Version ^1.5
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 phalcana/userguide contains the following files

Loading the files please wait ....