README

Phalcon Incubator

Phalcon is a web framework delivered as a C extension providing high performance and lower resource consumption.

This is a repository to publish/share/experiment with new adapters, prototypes or functionality that can potentially be incorporated into the framework.

We also welcome submissions of snippets from the community, to further extend the framework.

The code in this repository is written in PHP.

Installation

Installing via Composer

Install Composer in a common location or in your project:

curl -s http://getcomposer.org/installer | php

Then create the composer.json file as follows:

{
    "require": {
        "phalcon/incubator": "~3.0"
    }
}

If you are still using Phalcon 2.0.x, create the composer.json file as follows:

{
    "require": {
        "phalcon/incubator": "^2.0"
    }
}

Run the composer installer:

$ php composer.phar install

Installing via GitHub

Just clone the repository in a common location or inside your project:

git clone https://github.com/phalcon/incubator.git

For a specific Git branch (eg 2.0.13) please use:

git clone -b 2.0.13 git@github.com:phalcon/incubator.git

Autoloading from the Incubator

Add or register the following namespace strategy to your Phalcon\Loader in order to load classes from the incubator repository:

$loader = new Phalcon\Loader();

$loader->registerNamespaces([
    'Phalcon' => '/path/to/incubator/Library/Phalcon/'
]);

$loader->register();

Testing

See TESTING.md

Contributing

See CONTRIBUTING.md

Contributions Index

Acl

• Phalcon\Acl\Adapter\Database - ACL lists stored in database tables (@phalcon)
• Phalcon\Acl\Adapter\Mongo - ACL lists stored in Mongo collections (@phalcon)
• Phalcon\Acl\Adapter\Redis - ACL lists stored in a Redis cluster (@Green-Cat)
• Phalcon\Acl\Factory\Memory - ACL factory class intended for use with Memory adapter (@digitronac)

Annotations

• Phalcon\Annotations\Adapter\Memcached - Memcached adapter for storing annotations (@igusev)
• Phalcon\Annotations\Adapter\Redis - Redis adapter for storing annotations (@sergeyklay)
• Phalcon\Annotations\Adapter\Aerospike - Aerospike adapter for storing annotations (@sergeyklay)

Behaviors

• Phalcon\Mvc\Model\Behavior\Blameable - logs with every created or updated row in your database who created and who updated it (@phalcon)
• Phalcon\Mvc\Model\Behavior\NestedSet - Nested Set behavior for models (@braska)

Cache

• Phalcon\Cache\Backend\Aerospike - Aerospike backend for caching data (@sergeyklay)
• Phalcon\Cache\Backend\Database - Database backend for caching data (@phalcon)
• Phalcon\Cache\Backend\Wincache - Wincache backend for caching data (@nazwa)

Config

• Phalcon\Config\Loader - Dynamic config loader by file extension (@Kachit)
• Phalcon\Config\Adapter\Xml - Reads xml files and converts them to Phalcon\Config objects. (@sergeyklay)

Console

• Phalcon\Cli\Console\Extended - Extended Console application that uses annotations in order to create automatically a help description (@sarrubia)
• Phalcon\Cli\Environment - This component provides functionality that helps writing CLI oriented code that has runtime-specific execution params (@sergeyklay)

Crypt

• Phalcon\Legacy\Crypt - Port of Phalcon 2.0.x (legacy) Phalcon\Crypt (@sergeyklay)

Database

Adapter

• Phalcon\Db\Adapter\Cacheable\Mysql - MySQL adapter that aggressively caches all the queries executed (@phalcon)
• Phalcon\Db\Adapter\Factory - Phalcon DB adapters Factory (@Kachit)
• Phalcon\Db\Adapter\MongoDB - Database adapter for the new MongoDB extension (@tigerstrikemedia)
• Phalcon\Db\Adapter\Pdo\Oracle - Database adapter for the Oracle for the Oracle RDBMS. (@sergeyklay)

Dialect

• Phalcon\Db\Dialect\MysqlExtended - Generates database specific SQL for the MySQL RDBMS. Extended version. (@phalcon)
• Phalcon\Db\Dialect\Oracle - Generates database specific SQL for the Oracle RDBMS. (@sergeyklay)

Http

• Phalcon\Http - Uri utility (@tugrul)
• Phalcon\Http\Client - Http Request and Response (@tugrul)

Logger

• Phalcon\Logger\Adapter\Database - Adapter to store logs in a database table (@phalcon)
• Phalcon\Logger\Adapter\Firelogger - Adapter to log messages in the Firelogger console in Firebug (@phalcon)
• Phalcon\Logger\Adapter\File\Multiple - Adapter to log to multiple files (@rlaffers)

Mailer

• Phalcon\Mailer\Manager - Mailer wrapper over SwiftMailer (@KorsaR-ZN)

Model MetaData Adapters

• Phalcon\Mvc\Model\MetaData\Wincache - Adapter for the Wincache php extension

MVC

• Phalcon\Mvc\MongoCollection - Collection class for the new MongoDB Extension (@tigerstrikemedia)

Template Engines

• Phalcon\Mvc\View\Engine\Mustache - Adapter for Mustache (@phalcon)
• Phalcon\Mvc\View\Engine\Twig - Adapter for Twig (@phalcon)
• Phalcon\Mvc\View\Engine\Smarty - Adapter for Smarty (@phalcon)

Error Handling

• Phalcon\Error - Error handler used to centralize the error handling and displaying clean error pages (@theDisco)
• Phalcon\Utils\PrettyExceptions - Pretty Exceptions is an utility to show exceptions/errors/warnings/notices using a nicely visualization. (@phalcon / @kenjikobe)

Queue

• Phalcon\Queue\Beanstalk\Extended - Extended class to access the beanstalk queue service (@endeveit)

Test

• Phalcon\Test\FunctionalTestCase - Mvc app test case wrapper (@thecodeassassin)
• Phalcon\Test\ModelTestCase - Model test case wrapper (@thecodeassassin)
• Phalcon\Test\UnitTestCase - Generic test case wrapper (@thecodeassassin)

Translate

• Phalcon\Translate\Adapter\Database - Translation adapter using relational databases (@phalcon)
• Phalcon\Translate\Adapter\ResourceBundle - Translation adapter using ResourceBundle (@phalcon)

Session

• Phalcon\Session\Adapter\Aerospike - Aerospike adapter for storing sessions (@sergeyklay)
• Phalcon\Session\Adapter\Database - Database adapter for storing sessions (@phalcon)
• Phalcon\Session\Adapter\Mongo - MongoDb adapter for storing sessions (@phalcon)
• Phalcon\Session\Adapter\HandlerSocket - HandlerSocket adapter for storing sessions (@Xrymz)

Utils

• Phalcon\Utils\Slug - Creates a slug for the passed string taking into account international characters. (@niden)
• Phalcon\Avatar\Gravatar - Provides an easy way to retrieve a user's profile image from Gravatar site based on a given email address (@sergeyklay)

Validators

• Phalcon\Validation\Validator\CardNumber - Allows to validate credit card number using Luhn algorithm (@parshikov)
• Phalcon\Validation\Validator\ReCaptcha - The reCAPTCHA Validator (@pflorek)
• Phalcon\Validation\Validator\ConfirmationOf - Validates confirmation of other field value (@davihu)
• Phalcon\Validation\Validator\Decimal - Allows to validate if a field has a valid number in proper decimal format (negative and decimal numbers allowed) (@sergeyklay)
• Phalcon\Validation\Validator\MongoId - Validate MongoId value (@Kachit)
• Phalcon\Validation\Validator\PasswordStrength - Validates password strength (@davihu)

License

Incubator is open-sourced software licensed under the New BSD License. © Phalcon Framework Team and contributors