So you have decided to upgrade to v4! Congratulations!!
Phalcon v4 contains a lot of changes to components, including changes to interfaces, strict types, removal of components and additions of new ones. This document is an effort to help you upgrade your existing Phalcon application to v4. We will outline the areas that you need to pay attention to and make necessary alterations so that your code can run as smoothly as it has been with v3. Although the changes are significant, it is more of a methodical task than a daunting one.
Phalcon v4 supports only PHP 7.2 and above. PHP 7.1 was released 2 years ago and its active support has lapsed, so we decided to follow actively supported PHP versions.
Phalcon requires the PSR extension. The extension can be downloaded and compiled from this GitHub repository. Installation instructions are available in the README of the repository. Once the extension has been compiled and is available in your system, you will need to load it to your php.ini. You will need to add this line:
Alternatively some distributions add a number prefix on ini files. If that is the case, choose a high number for Phalcon (e.g. 50-phalcon.ini).
Download the latest zephir.phar from here. Add it to a folder that can be accessed by your system.
Clone the repository
git clone https://github.com/phalcon/cphalcon
git checkout tags/v4.0.0 ./
Check the module
php -m | grep phalcon
The Phalcon\Mvc\Application, Phalcon\Mvc\Micro and Phalcon\Mvc\Router now must have a URI to process
CSS and JS filters have been removed from the Assets component. Due to license limitations, the CSS and JS minifiers (filters) have been removed for v4. In future versions with the help of the community we can introduce these filters again. You can always implement your own using the supplied Phalcon\Assets\FilterInterface.
Renamed Phalcon\Assets\Resource to Phalcon\Assets\Asset
Renamed Phalcon\Assets\ResourceInterface to Phalcon\Assets\AssetInterface
Renamed Phalcon\Assets\Manager::addResource to Phalcon\Assets\Manager::addAsset
Renamed Phalcon\Assets\Manager::addResourceByType to Phalcon\Assets\Manager::addAssetByType
Renamed Phalcon\Assets\Manager::collectionResourcesByType to Phalcon\Assets\Manager::collectionAssetsByType
xcache, apc and memcache adapters have been deprecated and removed. The first two are not supported for PHP 7.2+. apc has been replaced with apcu and memcache can be replaced with the libmemcached one.
The Cache component has been rewritten to comply with PSR-16. This allows you to use the Phalcon\Cache to any application that utilizes a PSR-16 cache, not just Phalcon based ones.
In v3, the cache was split into two components, the Frontend and the Backend. This did create a bit of confusion but it was functional. In order to create a cache component you had to create the Frontend first and then inject that to the relevant Backend (which acted as an adapter also).
For v4, we rewrote the component completely. We first created a Storage class which is the basis of the Cache classes. We created Serializer classes whose sole responsibility is to serialize and unserialize the data before they are saved in the cache adapter and after they are retrieved. These classes are injected (based on the developer’s choice) to an Adapter object which connects to a backend (Memcached, Redis etc.), while abiding by a common adapter interface.
The Cache class implements PSR-16 and accepts an adapter in its constructor, which in turn is doing all the heavy lifting with connecting to the back end and manipulating data.
For a more detailed explanation on how the new Cache component works, please visit the relevant page in our documentation.
Removed Phalcon\Cli\Console::addModules in favor of Phalcon\Cli\Console::registerModules
Added delimiter, getDelimiter
Added getTaskSuffix(), setTaskSuffix()
Added setOptions, getOptions
Added Phalcon\Container, a proxy container class to the Phalcon\DI implementing PSR-11
Added global setting orm.case_insensitive_column_map to attempt to find value in the column map case-insensitively. Can be also enabled by setting caseInsensitiveColumnMap key in \Phalcon\Mvc\Model::setup()
Removed Phalcon\Db namespace. Replaced by Phalcon\Db\AbstractDb for necessary methods and Phalcon\Db\Enum for constants, i.e.:
Added fetchColumn, insertAsDict, updateAsDict
Added more column types for the Mysql adapter. The adapters support -TYPE_BIGINTEGER
TYPE_VARCHAR Some adapters do not support certain types. For instance JSON is not supported for Sqlite. It will be automatically changed to VARCHAR.
Changed addPrimaryKey to make primary key constraints names unique by prefixing them with the table name.
Added getParameter, isResolved
Changed Phalcon\Di\Service constructor to no longer takes the name of the service.
Removed Phalcon\Dispatcher::setModelBinding() in favor of Phalcon\Dispatcher::setModelBinder()
Added getHandlerSuffix(), setHandlerSuffix()
Added ability to set a custom template for the Flash Messenger.
Constructor no longer accepts an array for the CSS classes. You will need to use setCssClasses() to set your custom CSS classes for the component
The constructor now accepts an optional Phalcon\Escaper object, as well as a Phalcon\Session\Manager object (in the case of Phalcon\Flash\Session), in case you do not wish to use the DI and set it yourself.
The Filter component has been rewritten, utilizing a service locator. Each sanitizer is now enclosed on its own class and lazy loaded to provide maximum performance and the lowest resource usage as possible.
The Phalcon\Filter object has been rewritten to act as a service locator for different sanitizers. This object allows you to sanitize input as before using the sanitize() method.
The values sanitized are automatically cast to the relevant types. This is the default behavior for the int, bool and float filters.
When instantiating the filter object, it does not know about any sanitizers. You have two options:
CallingnewInstance() will return a Phalcon\Filter object with all the sanitizers registered. The sanitizers are lazy loaded so they are instantiated only when called from the locator.
Load Only Sanitizers You Want
You can instantiate the Phalcon\Filter component and either use the set() method to set all the sanitizers you need, or pass an array in the constructor with the sanitizers you want to register.
Using the FactoryDefault
If you use the Phalcon\Di\FactoryDefault container, then the Phalcon\Filter is automatically loaded in the container. You can then continue to use the service in your controllers or components as you did before. The name of the service in the Di is filter, just as before.
Also components that utilize the filter service, such as the Request object, transparently use the new filter locator. No additional changes required for those components.
Using a Custom Di
If you have set up all the services in the Phalcon\Di yourself and need the filter service, you will need to change its registration as follows:
NOTE: Note that even if you register the filter service manually, the name of the service must be filter so that other components can use it
The constants that the v3 Phalcon\Filter have somewhat changed.
By default the service sanitizers cast the value to the appropriate type so these are obsolete
FILTER_APHANUM has been removed - replaced by FILTER_ALNUM
FILTER_SPECIAL_CHARS has changed been removed - replaced by FILTER_SPECIAL
FILTER_ALNUM - replaced FILTER_ALPHANUM
FILTER_ALPHA - sanitize only alpha characters
FILTER_BOOL - sanitize boolean including “yes”, “no”, etc.
FILTER_LOWERFIRST - sanitze using lcfirst
FILTER_REGEX - sanitize based on a pattern (preg_replace)
FILTER_REMOVE - sanitize by removing characters (str_replace)
FILTER_REPLACE - sanitize by replacing characters (str_replace)
FILTER_SPECIAL - replaced FILTER_SPECIAL_CHARS
FILTER_SPECIALFULL - sanitize special chars (filter_var)
FILTER_UPPERFIRST - sanitize using ucfirst
FILTER_UPPERWORDS - sanitize using ucwords
Phalcon\Forms\Form::clear will no longer call Phalcon\Forms\Element::clear, instead it will clear/set default value itself, and Phalcon\Forms\Element::clear will now call Phalcon\Forms\Form::clear if it’s assigned to the form, otherwise it will just clear itself.
Phalcon\Forms\Form::getValue will now also try to get the value by calling Tag::getValue or element’s getDefault method before returning null, and Phalcon\Forms\Element::getValue calls Tag::getDefault only if it’s not added to the form.
Added Phalcon\Html\Breadcrumbs, a component that creates HTML code for breadcrumbs.
Added Phalcon\Html\Tag, a component that creates HTML elements. It will replace Phalcon\Tag in a future version. This component does not use static method calls.
Removed isSecureRequest in favor of isSecure
Removed isSoapRequested in favor of isSoap
Added hasHeader() method to Phalcon\Http\Response to provide the ability to check if a header exists.
Changed setHeaders now merges the headers with any pre-existing ones in the internal collection
Added two new events response::beforeSendHeaders and response::afterSendHeaders
Renamed Phalcon\Image\Adapter to Phalcon\Image\Adapter\AbstractAdapter
Renamed Phalcon\Image\Factory to Phalcon\Image\ImageFactory
<?phpusePhalcon\Image\Enum;// Resizing constraintsechoEnum::AUTO;// prints 4echoEnum::HEIGHT;// prints 3echoEnum::INVERSE;// prints 5echoEnum::NONE;// prints 1echoEnum::PRECISE;// prints 6echoEnum::TENSILE;// prints 7echoEnum::WIDTH;// prints 2// Flipping directionsechoEnum::HORIZONTAL;// prints 11echoEnum::VERTICAL;// prints 12
The Logger component has been rewritten to comply with PSR-3. This allows you to use the Phalcon\Logger to any application that utilizes a PSR-3 logger, not just Phalcon based ones.
In v3, the logger was incorporating the adapter in the same component. So in essence when creating a logger object, the developer was creating an adapter (file, stream etc.) with logger functionality.
For v4, we rewrote the component to implement only the logging functionality and to accept one or more adapters that would be responsible for doing the work of logging. This immediately offers compatibility with PSR-3 and separates the responsibilities of the component. It also offers an easy way to attach more than one adapter to the logging component so that logging to multiple adapters can be achieved. By using this implementation we have reduced the code necessary for this component and removed the old Logger\Multiple component.
Creating a Logger Component
<?phpusePhalcon\Logger;usePhalcon\Logger\Adapter\Stream;$adapter=newStream('/logs/application.log');$logger=newLogger('messages',['main'=>$adapter,]);$logger->error('Something went wrong');
The Phalcon\Logger\Multiple component has been removed. You can achieve the same functionality using the logger component and registering more than one adapter:
<?phpusePhalcon\Logger;usePhalcon\Logger\Adapter\Stream;$adapter1=newStream('/logs/first-log.log');$adapter2=newStream('/remote/second-log.log');$adapter3=newStream('/manager/third-log.log');$logger=newLogger('messages',['local'=>$adapter1,'remote'=>$adapter2,'manager'=>$adapter3,]);// Log to all adapters$logger->error('Something went wrong');
Phalcon\Messages\Message and its collection Phalcon\Messages\Messages are new components that handle messages for models and validation. In the past we had two components, one for validation and one for models. We have merged these two, so you should be getting back a MessageInterface back when calling save on a model or when retrieving validation messages.
Changed Phalcon\Mvc\Model to use the Phalcon\Messages\Message object for its messages
Changed Phalcon\Validation\* to use the Phalcon\Messages\Message object for its messages
Removed in version 4.0: - Removed $logger->begin() - Removed $logger->commit()
You can no longer assign data to models while saving them
The getSource() method has been marked as final. As such you can no longer override this method in your model to set the corresponding table/source of the RDBMS. Instead, you can now use the initialize() method and setSource() to set the source of your model.
The Phalcon\Text component has been removed in favor of the Phalcon\Helper\Str. The functionality offered by Phalcon\Text in v3 is replicated and enhanced in the new class: Phalcon\Helper\Str.
Removed Phalcon\Validation\Message and Phalcon\Mvc\Model\Message in favor of Phalcon\Messages\Message
Removed Phalcon\Validation\MessageInterface and Phalcon\Mvc\Model\MessageInterface in favor of Phalcon\Messages\MessageInterface
Removed Phalcon\Validation\Message and Phalcon\Mvc\Model\Message in favor of Phalcon\Messages\Message
Removed Phalcon\Validation\Message\Group in favor of Phalcon\Messages\Messages
Validator messages have been moved inside each validator
Added Phalcon\Validation\Validator\Ip, class used to validate ip address fields. It allows to validate a field selecting IPv4 or IPv6, allowing private or reserved ranges and empty values if necessary.
View caching along with the viewCache service have been removed from the framework because they were incompatible with the new Cache component. Developers can easily utilize a view cache from external services such as Varnish, Cloudflare etc. Additionally, developers can cache fragments by either using the Phalcon\Mvc\View\Simple::render() or the Phalcon\Mvc\View::toString(). Those two methods return the produced HTML that can be cached in the cache backend of your choice.