Phalcon IDE Stubs

https://github.com/phalcon/ide-stubs
Admin
Phalcon IDE Stubs provides complete IDE stubs for the Phalcon Framework that enable autocompletion...
Tokens:135,949
Snippets:1,052
Trust Score:9.6
License:BSD-3-Clause
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example — start and store data

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/session.md

Shows how to create a session manager, set a Stream adapter, start the session, store and retrieve data, and destroy the session.

```php
use Phalcon\Session\Manager;
use Phalcon\Session\Adapter\Stream;

$session = new Manager();
$session->setAdapter(new Stream(["savePath" => "/tmp"]));   // session_stream_options
$session->setName("phalcon-session");
$session->start();

$session->set("user_id", 42);
$id = $session->get("user_id");
$session->setId($session->getId());
if ($session->has("cart")) {
    $cart = $session->get("cart", [], true);   // read and remove
}
$session->destroy();
```

--------------------------------

### Registration and resolution example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/di.md

Shows how to register services using shared string definitions and closures, then resolve them via getShared, magic getter, and non-shared get. The example demonstrates that getShared returns the same instance while get returns a new one.

```php
use Phalcon\Di\Di;
use Phalcon\Http\Request;

$di = new Di();
$di->set("request", Request::class, true);          // shared string definition
$di->setShared("mailer", function () {             // shared closure
    return new \App\Mailer();
});

$request1 = $di->getShared("request");
$request2 = $di->getRequest();                      // magic getter
var_dump($request1 === $request2);                  // true

$request3 = $di->get("request");                    // non-shared: new instance
```

--------------------------------

### Mounting a group example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-router.md

Creates a Group with module and controller paths, sets a prefix and hostname, adds two routes, and mounts the group to the router. The example shows the typical setup for a blog module with routes for saving and editing.

```php
$blog = new Group(["module" => "blog", "controller" => "index"]);
$blog->setPrefix("/blog");
$blog->setHostname("blog.example.com");
$blog->add("/save", ["action" => "save"]);
$blog->add("/edit/{id}", ["action" => "edit"]);

$router->mount($blog);
```

--------------------------------

### Example - a Micro API

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-application.md

A complete example of a Micro application with before middleware, GET and POST routes, notFound and error handlers, and the handle call.

```php
use Phalcon\Di\FactoryDefault;
use Phalcon\Mvc\Micro;

$app = new Micro(new FactoryDefault());

$app->before(function () use ($app) {
    // simplistic auth gate
    if (empty($_SERVER["HTTP_X_API_KEY"])) {
        $app->response->setStatusCode(401)->send();
        $app->stop();   // halt remaining middleware
    }
});

$app->get("/say/welcome/{name}", function ($name) {
    echo "<h1>Welcome $name!</h1>";
});

$app->post("/api/users", function () use ($app) {
    $data = json_decode($app->request->getRawBody(), true);
    $app->response->setJsonContent(["created" => $data["email"]])->send();
});

$app->notFound(function () use ($app) {
    $app->response->setStatusCode(404)->setJsonContent(["error" => "Not Found"])->send();
});

$app->error(function (\Throwable $e) use ($app) {
    $app->response->setStatusCode(500)->setJsonContent(["error" => $e->getMessage()])->send();
});

$app->handle($_SERVER["REQUEST_URI"]);
```

--------------------------------

### Phalcon\Session\Manager — Usage Examples

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/session.md

Code examples demonstrating how to start a session, store and retrieve data, and handle errors.

```APIDOC
## Phalcon\Session\Manager — Usage Examples

### Description
These examples show how to use the Manager class to start a session, store and retrieve data, and handle errors.

### Example: Start and Store Data

```php
use Phalcon\Session\Manager;
use Phalcon\Session\Adapter\Stream;

$session = new Manager();
$session->setAdapter(new Stream(["savePath" => "/tmp"]));   // session_stream_options
$session->setName("phalcon-session");
$session->start();

$session->set("user_id", 42);
$id = $session->get("user_id");
$session->setId($session->getId());
if ($session->has("cart")) {
    $cart = $session->get("cart", [], true);   // read and remove
}
$session->destroy();
```

### Example: Error Handling

```php
use Phalcon\Session\Exceptions\SessionAlreadyStarted;

try {
    $session->setId("abc123");
} catch (SessionAlreadyStarted $e) {
    // cannot change id after start; regenerate instead
    $session->regenerateId(true);
}
```

```

--------------------------------

### Example - collections

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-application.md

Shows how to create a Micro\Collection, set its handler and prefix, define routes, and mount it to the app.

```php
use Phalcon\Mvc\Micro\Collection;

$users = new Collection();
$users->setHandler(\App\Controllers\UsersController::class);   // methods indexAction, showAction
$users->setPrefix("/api/users");
$users->get("/", "indexAction");
$users->get("/{id:[0-9]+}", "showAction");

$app->mount($users);
```

--------------------------------

### Route callbacks example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-router.md

Example showing how to use beforeMatch, setName, via, convert, and match callbacks.

```APIDOC
## Route callbacks example

### Description
Example demonstrating route configuration with callbacks.

### Code
```php
$router->add("/login", ["module" => "admin", "controller" => "session"])
    ->beforeMatch(function ($uri, $route) {
        return ($_SERVER["HTTP_X_REQUESTED_WITH"] ?? "") !== "xmlhttprequest";
    })
    ->setName("login")
    ->via(["GET", "POST"])
    ->convert("id", fn ($id) => (int) $id);

$router->add("/help", [])->match(function () {
    return $this->getResponse()->redirect("https://support.example.com/", true);
});
```

```

--------------------------------

### URL generation example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-url.md

Shows how to create a router, add a named route, instantiate Url, set base URIs, and generate various URLs including named-route, query-string, static, and path examples.

```php
use Phalcon\Mvc\Router;
use Phalcon\Mvc\Url;

$router = new Router();
$router->add("/posts/{year}/{slug}", ["controller" => "posts", "action" => "show"])
       ->setName("blog-post");

$url = new Url($router);
$url->setBaseUri("/invo/");
$url->setStaticBaseUri("https://cdn.example.com/");

echo $url->get("products/edit/1");                       // /invo/products/edit/1
echo $url->get(["for" => "blog-post", "year" => "2012", "slug" => "hello"]); // /invo/posts/2012/hello
echo $url->get("show/products", ["id" => 1, "name" => "Carrots"]);           // /invo/show/products?id=1&name=Carrots
echo $url->getStatic("img/logo.png");                     // https://cdn.example.com/img/logo.png
echo $url->path("var/www/htdocs/");                       // basePath + path
```

--------------------------------

### Definition arrays and providers example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/di.md

Shows how to register a service using a definition array with arguments and calls, and how to register a provider using an anonymous class. The example demonstrates recursive resolution and applying calls.

```php
use Phalcon\Di\DiInterface;
use Phalcon\Di\ServiceProviderInterface;

$di->set("logger", [
    "className" => \Phalcon\Logger\Logger::class,
    "arguments" => [
        ["type" => "parameter", "value" => "app"],
        ["type" => "service", "name" => "logAdapter"],
    ],
    "calls" => [["method" => "setLogLevel", "arguments" => [["type" => "parameter", "value" => 4]]]],
]);

$di->register(new class implements ServiceProviderInterface {
    public function register(DiInterface $di): void
    {
        $di->setShared("config", fn () => new \Phalcon\Config\Config(require "config.php"));
    }
});

$logger = $di->getShared("logger"); // resolves recursively, applies calls
```

--------------------------------

### PSR-4 style namespace loading example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/autoload.md

Shows how to configure the loader with namespaces and an extension, then register it. The example creates an instance of App\Services\Mailer and demonstrates debug output.

```php
use Phalcon\Autoload\Loader;

$loader = new Loader(true);          // debug mode
$loader->setNamespaces([
    "App\\" => "/var/www/app/",
]);
$loader->addExtension("php");
$loader->register();

$app = new \App\Services\Mailer();   // /var/www/app/Services/Mailer.php

var_dump($loader->getFoundPath());   // /var/www/app/Services/Mailer.php
print_r($loader->getDebug());
```

--------------------------------

### Registering modules example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/application.md

Shows how to extend AbstractApplication, register modules with class names and paths, set a default module, and retrieve module information.

```php
use Phalcon\Application\AbstractApplication;

class MyApp extends AbstractApplication
{
    public function init(): void
    {
        $this->registerModules([
            "frontend" => [
                "className" => \Multiple\Frontend\Module::class,
                "path"      => "../apps/frontend/Module.php",
            ],
            "backend" => [
                "className" => \Multiple\Backend\Module::class,
                "path"      => "../apps/backend/Module.php",
            ],
        ]);

        $this->setDefaultModule("frontend");
    }
}

$app = new MyApp(new \Phalcon\Di\FactoryDefault());
$app->init();
echo $app->getDefaultModule();       // "frontend"
$module = $app->getModule("backend"); // ['className' => ..., 'path' => ...]
```

--------------------------------

### Example — error handling

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/session.md

Shows how to catch SessionAlreadyStarted exception when setting the session id after start, and regenerate the id instead.

```php
use Phalcon\Session\Exceptions\SessionAlreadyStarted;

try {
    $session->setId("abc123");
} catch (SessionAlreadyStarted $e) {
    // cannot change id after start; regenerate instead
    $session->regenerateId(true);
}
```

--------------------------------

### Example — find, create, update

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-model.md

Shows how to define a model, use finders, create a new record, and handle validation errors.

```php
use Phalcon\Mvc\Model;

class Products extends Model
{
    public $id;
    public $name;
    public $price;
}

// Finders
$products = Products::find(["conditions" => "price > ?0", "bind" => [50], "order" => "name"]);
$first    = Products::findFirst("id = 1");
$count    = Products::count();

// Create
$product = new Products();
$product->name  = "Widget";
$product->price = 9.99;
if (!$product->create()) {
    foreach ($product->getMessages() as $message) {
        echo $message->getMessage();
    }
}
```

--------------------------------

### Using Phalcon\Session\Bag for a shopping cart

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/session.md

Shows how to instantiate a Bag with a session manager and a name, set and get items, and clear the bag. The example uses a cart with items array.

```php
$cart = new Bag($session, "cart");
$cart->set("items", [["id" => 1, "qty" => 2]]);
$items = $cart->get("items");          // via Collection API
$cart->clear();
```

--------------------------------

### Dispatching a request with Phalcon\Mvc\Dispatcher

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/dispatcher.md

Sets up a dispatcher with a DI container, configures controller, action, and parameters, then dispatches to get a controller instance. The example outputs the controller class name.

```php
use Phalcon\Di\Di;
use Phalcon\Mvc\Dispatcher;

$di = new Di();
$dispatcher = new Dispatcher();
$dispatcher->setDI($di);

$dispatcher->setControllerName("posts");
$dispatcher->setActionName("index");
$dispatcher->setParams(["page" => 2]);

$controller = $dispatcher->dispatch();   // instance of PostsController
echo $controller::class;
```

--------------------------------

### Simple View Rendering Example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-view.md

Shows how to instantiate the Simple view renderer, set the views directory, and render a template with parameters. The render method returns the rendered content as a string.

```php
$simple = new \Phalcon\Mvc\View\Simple();
$simple->setViewsDir("app/views/");
echo $simple->render("emails/welcome", ["user" => $user]);
```

--------------------------------

### Example of Model::find with parameters

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-model.md

Shows how to pass conditions, bind, order, and limit to the static find method.

```php
Model::find(["conditions" => "a = :v:", "bind" => ["v" => 1], "order" => "id DESC", "limit" => 10])
```

--------------------------------

### Install via Composer

Source: https://github.com/phalcon/ide-stubs/blob/master/README.md

Use this command to install the Phalcon IDE stubs as a development dependency via Composer.

```bash
composer require --dev phalcon/ide-stubs
```

--------------------------------

### Stream logging with filters

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/logger.md

Example of creating a logger, adding a stream adapter, setting a line formatter, and logging info and error messages with context.

```php
use Phalcon\Logger\Logger;
use Phalcon\Logger\Adapter\Stream;
use Phalcon\Logger\Formatter\Line;

$logger = new Logger("app");
$logger->addAdapter("file", new Stream("/var/log/app.log"));
$logger->getAdapter("file")->setFormatter(new Line("%date% [%level%] %message%"));

$logger->setLogLevel(Logger::DEBUG);
$logger->info("User logged in", ["id" => 42]);
$logger->error("Connection failed", ["dsn" => "mysql:..."]);
```

--------------------------------

### Example — roles, components, rules

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/acl.md

Shows how to set up an ACL with roles, components, and rules using the Memory adapter. Demonstrates role inheritance and the default DENY action, with var_dump output showing inherited grants and denied access.

```php
use Phalcon\Acl\Adapter\Memory;
use Phalcon\Acl\Component;
use Phalcon\Acl\Role;
use Phalcon\Acl\Enum;

$acl = new Memory();
$acl->setDefaultAction(Enum::DENY);

$guest  = new Role("guest");
$member = new Role("member");
$acl->addRole($guest);
$acl->addRole($member, ["guest"]);            // member inherits guest grants

$acl->addComponent(new Component("products"), ["list", "create", "edit", "delete"]);

$acl->allow("guest", "products", "list");
$acl->allow("member", "products", ["create", "edit"]);

var_dump($acl->isAllowed("member", "products", "list"));    // true (inherited)
var_dump($acl->isAllowed("guest", "products", "create"));   // false (default DENY)
```

--------------------------------

### Transactions and errors example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/logger.md

Shows how to use begin, commit, and rollback for transaction handling, including catching TransactionNotActive exceptions.

```php
use Phalcon\Logger\Exceptions\TransactionNotActive;

$logger->begin();
$logger->debug("bulk import starting");
try {
    // ... work ...
    $logger->commit();          // flush the queue
} catch (\Throwable $e) {
    $logger->rollback();        // drop queued messages
}

try {
    $logger->commit();          // no open transaction
} catch (TransactionNotActive $e) {
    $logger->error("nothing to commit");
}
```

--------------------------------

### CacheFactory usage example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/cache.md

Demonstrates creating a cache factory with adapter and serializer factories, then creating a cache instance with the 'apcu' adapter and loading a cache from a Redis configuration.

```php
use Phalcon\Cache\CacheFactory;
use Phalcon\Cache\AdapterFactory;
use Phalcon\Storage\SerializerFactory;

$cacheFactory = new CacheFactory(new AdapterFactory(new SerializerFactory()));
$cache = $cacheFactory->newInstance("apcu", ["lifetime" => 3600]);
$cacheFromFile = $cacheFactory->load(["adapter" => "redis", "options" => ["host" => "127.0.0.1"]]);
```

--------------------------------

### Config object access and dot-path example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/config.md

Shows how to create a Config instance, access nested values via property and dot-path, change the path delimiter, merge configurations, and print the result.

```php
use Phalcon\Config\Config;

$config = new Config([
    "database" => [
        "adapter"  => "Mysql",
        "host"     => "localhost",
        "username" => "scott",
        "password" => "cheetah",
    ],
    "app" => ["debug" => false],
]);

echo $config->database->adapter;                     // Mysql (property access)
echo $config->path("database.host");                 // localhost
echo $config->path("database.host.port", 3306);      // default used
$config->setPathDelimiter("/");
echo $config->path("database/host");                 // localhost
$config->setPathDelimiter();

$merged = $config->merge(new Config(["database" => ["port" => 3306]]));
print_r($merged->toArray());
```

--------------------------------

### Class map and files with error handling example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/autoload.md

Demonstrates setting a class map and files, then registering and loading files. Includes error handling for the file checking callback, falling back to 'is_file' if 'stream_resolve_include_path' is not callable.

```php
$loader = new Loader();
$loader->setClasses([
    "Legacy\\Foo" => "/opt/legacy/Foo.php",
    "Legacy\\Bar" => "/opt/legacy/Bar.php",
]);
$loader->setFiles(["/opt/legacy/helpers.php"]);

try {
    $loader->setFileCheckingCallback("stream_resolve_include_path");
} catch (\Phalcon\Autoload\Exceptions\LoaderMethodNotCallable $e) {
    $loader->setFileCheckingCallback("is_file");
}

$loader->register();
$loader->loadFiles();                 // require helpers.php now
$foo = new \Legacy\Foo();             // loaded from the explicit map
```

--------------------------------

### PHP services file example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/di.md

A services.php file returns an array of service descriptors with className, shared, and arguments keys. For PHP, the argument key is 'service'.

```php
// services.php
return [
    'myComponent' => ['className' => '\Acme\Components\MyComponent', 'shared' => true],
    'group' => [
        'className' => '\Acme\Group',
        'arguments' => [['type' => 'service', 'service' => 'myComponent']],
    ],
];
```

--------------------------------

### Example - set a signed cookie

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/http-cookie.md

Creates a cookie with a CSPRNG-generated signing key, sets HTTP-only, secure, and SameSite options, then sends it. The value is echoed as a string.

```php
use Phalcon\Encryption\Security\Random;
use Phalcon\Http\Cookie;

$signKey = (new Random())->base58(40);   // >= 32 chars, CSPRNG

$cookie = (new Cookie("theme", "dark", time() + 2592000))
    ->setHttpOnly(true)
    ->setSecure($request->isSecure())
    ->setSignKey($signKey)
    ->setOptions(["samesite" => "Lax"]);

$cookie->send();     // sends header + stores definition in session
echo (string) $cookie; // "dark"
```

--------------------------------

### Full-stack MVC bootstrap with Phalcon\Mvc\Application

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-application.md

Full-stack MVC bootstrap example. Creates a FactoryDefault DI container, instantiates the Application, registers a frontend module with its class and path, enables implicit view, handles the request URI, and echoes the response content.

```php
use Phalcon\Di\FactoryDefault;
use Phalcon\Mvc\Application;

$di = new FactoryDefault();
$application = new Application($di);

$application->registerModules([
    "frontend" => ["className" => \App\Modules\Frontend\Module::class, "path" => __DIR__ . "/modules/frontend/Module.php"],
]);

$application->useImplicitView(true);
$response = $application->handle($_GET["_url"] ?? "/");

echo $response->getContent();
```

--------------------------------

### Classic asset management with Phalcon\Assets\Manager

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/assets.md

Shows how to instantiate the Manager with a TagFactory, add CSS and JS assets (local and external), add inline JS, and output the corresponding HTML tags. The example uses the $di service locator and demonstrates the addCss, addJs, addInlineJs, outputCss, outputJs, and outputInlineJs methods.

```php
use Phalcon\Assets\Manager;
use Phalcon\Html\TagFactory;

$assets = new Manager(new TagFactory($di));
$assets->addCss("css/style.css");
$assets->addCss("https://cdn.example.com/lib.css", false);     // external
$assets->addJs("js/app.js", true, true, ["defer" => true], "1.2.0", true);
$assets->addInlineJs("console.log('boot');");

// in layout:
echo $assets->outputCss();    // <link rel="stylesheet" href="css/style.css">...
echo $assets->outputJs();
echo $assets->outputInlineJs();
```

--------------------------------

### Route callbacks example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-router.md

Shows how to configure a route with beforeMatch, setName, via, convert, and match callbacks. The first route uses beforeMatch to reject AJAX requests and converts the 'id' parameter to an integer. The second route uses match to directly handle the request and redirect.

```php
$router->add("/login", ["module" => "admin", "controller" => "session"])
    ->beforeMatch(function ($uri, $route) {
        return ($_SERVER["HTTP_X_REQUESTED_WITH"] ?? "") !== "xmlhttprequest";
    })
    ->setName("login")
    ->via(["GET", "POST"])
    ->convert("id", fn ($id) => (int) $id);

$router->add("/help", [])->match(function () {
    return $this->getResponse()->redirect("https://support.example.com/", true);
});
```

--------------------------------

### Basic routing with Phalcon\Mvc\Router

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-router.md

Basic routing example: creates a Router, adds routes with patterns and HTTP methods, sets defaults, defines a notFound handler, then handles a request and prints the matched controller, action, and params.

```php
use Phalcon\Mvc\Router;

$router = new Router();
$router->add("/documentation/{chapter}/{name}\.{type:[a-z]+}", [
    "controller" => "documentation",
    "action"     => "show",
]);
$router->addGet("/about", "About::index");
$router->addPost("/users", ["controller" => "users", "action" => "create"]);
$router->setDefaults(["module" => "frontend", "action" => "index"]);
$router->notFound(["controller" => "errors", "action" => "show404"]);

$router->handle("/documentation/1/examples.html");

echo $router->getControllerName();   // documentation
echo $router->getActionName();       // show
print_r($router->getParams());       // ['chapter' => '1', 'name' => 'examples', 'type' => 'html']
```

--------------------------------

### Basic usage of Phalcon\Cache\Cache

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/cache.md

Shows how to create a cache with a Redis adapter, set and get values, use multiple operations, and check/delete a key. The TTL is in seconds; default value is returned on miss.

```php
use Phalcon\Cache\Cache;
use Phalcon\Cache\Adapter\Redis;
use Phalcon\Cache\Exception\InvalidArgumentException;

$cache = new Cache(new Redis(["host" => "127.0.0.1", "port" => 6379, "index" => 0, "lifetime" => 3600]));

$cache->set("stats", ["views" => 1000], 60);
$stats = $cache->get("stats", []);          // default on miss
$cache->setMultiple(["a" => 1, "b" => 2], 300);
$all = $cache->getMultiple(["a", "b"]);

if ($cache->has("token")) {
    $cache->delete("token");
}

```

--------------------------------

### Remote and query handling example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-url.md

Demonstrates remote URI detection and the replaceArgs parameter for query string handling. Shows that a scheme is passed through untouched and that replaceArgs overwrites existing keys.

```php
// Remote URI detection: scheme present -> returned untouched
echo $url->get("https://phalcon.io/", null, false);       // https://phalcon.io/

// ReplaceArgs: without it "page" duplicates, with it the key is overwritten
echo $url->get("http://example.com?page=1", ["page" => 5], null, null, true);
// http://example.com?page=5
```

--------------------------------

### Guard + attempt example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/auth.md

Shows how to instantiate a Manager with an AccessLocator, create a Model adapter with a Security instance and ModelAdapterConfig, and build a Session guard with request, cookies, session, and SessionGuardConfig. Registers the guard as default, attempts login with credentials and remember flag, retrieves the authenticated user id/object, and logs out. The adapter's validateCredentials() returning false causes attempt() to fail.

```php
use Phalcon\Auth\Manager;
use Phalcon\Auth\Access\AccessLocator;
use Phalcon\Auth\Adapter\Model;
use Phalcon\Auth\Adapter\Config\ModelAdapterConfig;
use Phalcon\Auth\Guard\Session;
use Phalcon\Auth\Guard\Config\SessionGuardConfig;
use Phalcon\Encryption\Security;

$manager = new Manager(new AccessLocator());

// Model adapter authenticates against a Phalcon ORM model
$adapter = new Model(
    new Security(),
    new ModelAdapterConfig(User::class, "id")   // model class + id column
);

// Session guard needs request, cookies bag, session manager (+ optional config)
$guard = new Session(
    $adapter,
    $di->get("request"),
    $di->get("cookies"),
    $di->get("session"),
    new SessionGuardConfig("web", rememberTtl: 31536000, rememberSecure: true)
);
$manager->addGuard("web", $guard, true);

if ($manager->attempt(["email" => "user@example.com", "password" => "secret"], true)) {
    $userId = $manager->id();
    $user   = $manager->user();          // AuthUser|null
} else {
    // failed — the adapter's validateCredentials() returned false
}
$manager->logout();
```

--------------------------------

### Example — validation message

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/messages.md

Shows how to create a Message instance with field, type, code, and metadata, then output its string representation, field, and JSON encoding.

```php
use Phalcon\Messages\Message;

$msg = new Message(
    "Sorry, an invoice cannot be named Peter",
    "name",            // field
    "InvalidValue",    // type
    1001,              // code
    ["rule" => "not_peter"]
);

echo (string) $msg;            // "Sorry, an invoice cannot be named Peter"
echo $msg->getField();         // "name"
echo json_encode($msg);        // {"message":"...","field":"name","type":"InvalidValue","code":1001,"metaData":{...}}
```

--------------------------------

### Encryption round-trip example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/encryption.md

Shows how to encrypt and decrypt a message using a custom cipher and key, including base64 encoding.

```php
use Phalcon\Encryption\Crypt;

$crypt = new Crypt();
$crypt->setCipher("aes-256-ctr");
$crypt->setKey("T4\xb1\x8d\xa9\x98\x05\\\x8c\xbe\x1d\x07&[\x99\x18\xa4~Lc1\xbeW\xb3");

$encrypted = $crypt->encrypt("The message to be encrypted");
$decrypted = $crypt->decrypt($encrypted);
echo $decrypted;   // The message to be encrypted

$b64 = $crypt->encryptBase64("payload", null, true);   // URL-safe base64
echo $crypt->decryptBase64($b64, null, true);
```

--------------------------------

### HMAC and password hashing usage example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/encryption.md

Shows how to hash a password with bcrypt, verify it, rehash if legacy, and compute an HMAC signature. The computeHmac method throws Exception on failure.

```php
use Phalcon\Encryption\Security;

$security = new Security($session, $request);
$hash = $security->hash("s3cret", ["cost" => 12]);   // bcrypt

if ($security->checkHash($password, $user->password_hash)) {
    // OK — rehash if algorithm upgraded:
    if ($security->isLegacyHash($user->password_hash)) {
        $user->password_hash = $security->hash($password);
        $user->save();
    }
}

$signature = $security->computeHmac($data, $key, "sha256", true);  // @throws Exception
```

--------------------------------

### Example - error handling for signing and encryption

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/http-cookie.md

Handles CookieKeyTooShort when signing with a short key, retrying with a proper CSPRNG key. Also catches missing crypt/filter services when enabling encryption.

```php
use Phalcon\Http\Cookie\Exceptions\CookieKeyTooShort;

try {
    $cookie = (new Cookie("session_meta", "abc"))
        ->setSignKey("short");               // throws CookieKeyTooShort
} catch (CookieKeyTooShort $e) {
    // salt from a proper CSPRNG and retry
    $cookie = (new Cookie("session_meta", "abc"))
        ->setSignKey((new Random())->base58(40));
}

// Encryption path requires services in the DI
try {
    $cookie->useEncryption(true)->getValue();
} catch (\Phalcon\Http\Cookie\Exceptions\CryptServiceUnavailable|\Phalcon\Http\Cookie\Exceptions\FilterServiceUnavailable $e) {
    // crypt / filter service missing from container
    $cookie->useEncryption(false);
}
```

--------------------------------

### Example — transactions and error handling

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-model.md

Demonstrates using a transaction manager to wrap model operations, committing on success and rolling back on failure, with specific exception handling.

```php
use Phalcon\Mvc\Model;
use Phalcon\Mvc\Model\Transaction\Manager as TxManager;

$txManager = new TxManager();
$tx = $txManager->get();

try {
    $a = Products::findFirst("id = 1");
    $a->setTransaction($tx);
    $a->price = 12.5;

    $b = new Products();
    $b->setTransaction($tx);
    $b->name = "Gadget";
    if (!$b->create()) {
        throw new \RuntimeException("validation failed");
    }

    $tx->commit();
} catch (\Phalcon\Mvc\Model\Transaction\Failed $e) {
    $tx->rollback();                    // Failed(string $message, ?ModelInterface $record = null)
    error_log($e->getMessage());
} catch (\Phalcon\Mvc\Model\Exception $e) {
    $tx->rollback();
    // e.g. ValidationFailed(ModelInterface $model, array $validationMessages),
    // RecordNotPersisted, RecordCannotRefresh ... (see errors.md)
}
```

--------------------------------

### Classic View Rendering Flow

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-view.md

Demonstrates the standard rendering flow using the View class: setting directories, registering the Php engine, starting the view, setting variables, rendering a template, and finishing. The rendered content is echoed and templates have access to the set variables and the partial() helper.

```php
use Phalcon\Mvc\View;

$view = new View();
$view->setViewsDir("app/views/");
$view->setLayoutsDir("layouts/");
$view->setPartialsDir("partials/");
$view->registerEngines([".phtml" => \Phalcon\Mvc\View\Engine\Php::class]);

$view->start();
$view->setVars(["products" => $products, "title" => "Recent posts"]);
$view->render("posts", "recent");       // app/views/posts/recent.phtml
$view->finish();

echo $view->getContent();
// Inside templates: $products, $title; partial("shared/footer", ["content" => $html]);
```

--------------------------------

### Example — sanitized input

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/http-request.md

Shows how to create a Request, set the DI to provide the filter service, and retrieve sanitized POST and query parameters. Also demonstrates checking for POST and AJAX requests and decoding the raw body as JSON.

```php
use Phalcon\Http\Request;

$request = new Request();
$di = new \Phalcon\Di\FactoryDefault();
$request->setDI($di);                    // provides the "filter" service

$email = $request->getPost("user_email", "email");
$id    = $request->getQuery("id", "int", 150);
$tags  = $request->getPost("tags", ["string"], [], false, true); // non-recursive

if ($request->isPost() && $request->isAjax()) {
    $payload = json_decode($request->getRawBody(), true);
}
```

--------------------------------

### View lifecycle methods

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-view.md

Core methods for the rendering lifecycle: start, render, finish, processRender, and getContent. render() returns false when disabled or view missing.

```php
public function start(): static          // open output buffering
public function render(string $controllerName, string $actionName, array $params = []): static|false
public function finish(): static         // close buffering
public function processRender(string $controllerName, string $actionName, array $params = [], bool $fireEvents = true): bool
public function getContent(): string     // via ViewInterface (buffered output)
```

--------------------------------

### Example: creating an event and handling EventNotCancelable

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/events.md

Shows how to instantiate an Event with type, source, and data, then call stop() inside a try-catch to handle the EventNotCancelable exception when the event is not cancelable.

```php
$event = new Event("db:beforeQuery", $connection, ["sql" => $sql]);
try {
    $event->stop();
} catch (\Phalcon\Events\Exceptions\EventNotCancelable $e) {
    // constructed as new Event("...", $source, $data, false)
}
```

--------------------------------

### Authorization gates example

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/auth.md

Demonstrates registering an access class via addAccessList, selecting it with access(), and restricting to specific actions with only(). Calls authorize() on the active gate and catches ActiveAccessRequired when no gate is selected or AccessDenied, whose message carries type and name; responds with HTTP 403 on denial.

```php
$manager->addAccessList([
    "admin" => \App\Auth\Access\AdminAccess::class,   // implements Phalcon\Contracts\Auth\Access\Access
]);

$manager->access("admin")->only("edit", "delete");

try {
    $canEdit = $manager->getAccess()->authorize("edit");   // gate-dependent API
} catch (\Phalcon\Auth\Exceptions\ActiveAccessRequired $e) {
    // no gate selected yet
} catch (\Phalcon\Auth\Exceptions\AccessDenied $e) {
    // $e->getMessage() carries type + name
    http_response_code(403);
}
```

--------------------------------

### Example — proxy-aware client IP

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/http-request.md

Demonstrates configuring trusted proxies and a custom proxy header, then retrieving the client address with forwarded header support and the HTTP host with strict validation. Catches InvalidHost exceptions and returns HTTP 400 on failure.

```php
$request
    ->setTrustedProxies(["10.0.0.0/8", "172.16.0.0/12"])
    ->setTrustedProxyHeader("HTTP_CLIENT_IP");

try {
    $ip = $request->getClientAddress(true);
    $host = $request->setStrictHostCheck(true)->getHttpHost();
} catch (\Phalcon\Http\Request\Exceptions\InvalidHost $e) {
    // UnexpectedValueException: host name failed strict validation
    http_response_code(400);
}
```

--------------------------------

### Named collection with filters using Phalcon\Assets\Collection

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/assets.md

Shows how to create a named collection, add JS assets with filtering disabled, apply a Jsmin filter, enable concatenation, set a prefix, and output the collection. The example uses the set and outputJs methods on the Manager.

```php
use Phalcon\Assets\Manager;
use Phalcon\Assets\Collection;
use Phalcon\Assets\Filters\Jsmin;

$admin = new Collection();
$admin->addJs("js/admin/core.js", false, false);
$admin->addJs("js/admin/dashboard.js", false, false);
$admin->addFilter(new Jsmin());
$admin->join(true);            // concatenate into one file
$admin->setPrefix("dist/");

$assets->set("admin", $admin);
echo $assets->outputJs("admin");
```

--------------------------------

### Phalcon\Session\Manager — Session Lifecycle Methods

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/session.md

Methods to manage the session lifecycle: start, destroy, check existence, get status, regenerate ID, manage adapter, ID, name, and options.

```APIDOC
## Phalcon\Session\Manager — Session Lifecycle Methods

### Description
These methods manage the session lifecycle: starting, destroying, checking existence, retrieving status, regenerating the session ID, managing the adapter, ID, name, and options.

### Methods

#### `start(): bool`
- **Returns**: `bool` - Whether the session started successfully.
- **Description**: Starts the session; refuses when headers already sent.

#### `destroy(): void`
- **Returns**: `void`
- **Description**: Destroys/ends the session.

#### `exists(): bool`
- **Returns**: `bool` - Whether the session has been started.
- **Description**: Checks if the session has been started.

#### `status(): int`
- **Returns**: `int` - One of the `SESSION_*` constants.
- **Description**: Returns the current session status.

#### `regenerateId(bool $deleteOldSession = true): ManagerInterface`
- **Parameters**:
  - `$deleteOldSession` (bool) - Optional - Whether to delete the old session file.
- **Returns**: `ManagerInterface` - The manager instance.
- **Description**: Regenerates the session ID via the save handler.

#### `getAdapter(): SessionHandlerInterface|null`
- **Returns**: `SessionHandlerInterface|null` - The stored adapter or null.
- **Description**: Returns the session adapter.

#### `setAdapter(\SessionHandlerInterface $adapter): ManagerInterface`
- **Parameters**:
  - `$adapter` (\SessionHandlerInterface) - Required - The session handler adapter.
- **Returns**: `ManagerInterface` - The manager instance.
- **Description**: Attaches a session adapter.

#### `getId(): string`
- **Returns**: `string` - The session ID.
- **Description**: Returns the current session ID.

#### `setId(string $sessionId): ManagerInterface`
- **Parameters**:
  - `$sessionId` (string) - Required - The new session ID.
- **Returns**: `ManagerInterface` - The manager instance.
- **Throws**: `InvalidSessionId`, `SessionAlreadyStarted`
- **Description**: Sets the session ID.

#### `getName(): string`
- **Returns**: `string` - The session name.
- **Description**: Returns the session name.

#### `setName(string $name): ManagerInterface`
- **Parameters**:
  - `$name` (string) - Required - The new session name.
- **Returns**: `ManagerInterface` - The manager instance.
- **Throws**: `InvalidSessionName`, `SessionModificationDenied` (after start or invalid name)
- **Description**: Sets the session name.

#### `getOptions(): array`
- **Returns**: `array` - The internal options.
- **Description**: Returns the session options.

#### `setOptions(array $options): void`
- **Parameters**:
  - `$options` (array) - Required - Options to merge.
- **Returns**: `void`
- **Description**: Merges new options into the existing ones.

```

--------------------------------

### Attributes bag methods and usage

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/http-request.md

Shows the getAttributes method signature and an example of setting and getting a request-scoped value. The AttributeBag is a Collection subclass that is created empty on first access and returns the same instance afterward.

```php
public function getAttributes(): AttributeBag   // created empty on first access, same instance after
```

```php
$request->getAttributes()->set("user", $user);
$user = $request->getAttributes()->get("user");
```

--------------------------------

### GET /{routePattern}

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-application.md

Registers a GET route that maps to a handler callable.

```APIDOC
## [GET] /{routePattern}

### Description
Registers a GET route that maps to a handler callable.

### Method
GET

### Endpoint
/{routePattern}

### Parameters
#### Path Parameters
- **routePattern** (string) - Required - The route pattern to match.

### Request Example
```php
$app->get("/say/welcome/{name}", function ($name) { echo "<h1>Welcome $name!</h1>"; });
```

### Response
#### Success Response (200)
- **body** (string) - The handler output.

#### Response Example
```
<h1>Welcome John!</h1>
```
```

--------------------------------

### Data access methods

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/session.md

Methods to get, set, check, and remove session data with optional removal on get.

```php
public function get(string $key, $defaultValue = null, bool $remove = false): mixed
public function set(string $key, $value): void
public function has(string $key): bool
public function remove(string $key): void
```

--------------------------------

### Initialize FactoryDefault container

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/di.md

Demonstrates initializing the FactoryDefault container and retrieving a pre-registered service.

```php
use Phalcon\Di\FactoryDefault;

$di = new FactoryDefault();
$request = $di->getShared("request");   // already registered
```

--------------------------------

### begin()

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/logger.md

Begins a transaction, queueing messages.

```APIDOC
## Method: begin

### Description
Starts a transaction, causing log messages to be queued until commit or rollback.

### Method
`begin`

### Parameters
None.

### Return Value
- **static** - Returns the logger instance for chaining.

### Exceptions
- **TransactionAlreadyActive** - If a transaction is already active.

### Request Example
```php
$logger->begin();
```
```

--------------------------------

### Resolution methods: get and getShared

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/di.md

Resolves services from the container. get returns a new instance each call, while getShared returns a cached instance.

```php
public function get(string $name, $parameters = null): mixed       // new instance each call
public function getShared(string $name, $parameters = null): mixed // cached instance
```

--------------------------------

### Using Yaml adapter with callbacks

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/config.md

Shows how to instantiate the Yaml adapter with a file path and a callbacks array for handling custom YAML tags like !approot.

```php
use Phalcon\Config\Adapter\Yaml;

$config = new Yaml("config.yaml", ["!env" => fn (string $v) => getenv($v)]);
```

--------------------------------

### addGet

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-router.md

Adds a route that matches GET requests.

```APIDOC
## addGet

### Description
Adds a route that matches GET requests.

### Method
addGet

### Parameters
- **$pattern** (string) - Required - URL pattern.
- **$paths** (array|string) - Required - Controller/action paths.

### Return Value
- \Phalcon\Mvc\Router\RouteInterface

### Request Example
```php
$router->addGet("/about", "About::index");
```
```

--------------------------------

### AbstractAdapter::offsetGet

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/translate.md

Gets a translation value using ArrayAccess.

```APIDOC
## AbstractAdapter::offsetGet

### Description
Gets a translation value using ArrayAccess. Maps to `query()`.

### Method
`offsetGet`

### Parameters
- **offset** (mixed) - Required - The offset to get.

### Request Example
```php
$value = $adapter['key'];
```

### Response
Returns the translated string.
```

--------------------------------

### Router::setUriSource

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-router.md

Sets the URI source to use (GET _url or REQUEST_URI).

```APIDOC
## Router::setUriSource

### Description
Sets the source of the URI to be matched.

### Method
`setUriSource`

### Parameters
- **$uriSource** (int) - Required - One of the URI_SOURCE_* constants.

### Return
`static`
```

--------------------------------

### Router::addGet

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/mvc-router.md

Registers a route for the GET HTTP method. Accepts pattern, paths, and position.

```APIDOC
## Router::addGet

### Description
Adds a route constrained to the GET HTTP method.

### Method
`addGet`

### Parameters
- **$pattern** (string) - Required - URI template.
- **$paths** (array|string|null) - Optional - Default: `null` - Controller/action mapping.
- **$position** (int) - Optional - Default: `Router::POSITION_LAST` - Position in route list.

### Return
`RouteInterface`
```

--------------------------------

### Resolve a service directly

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/di.md

Example of resolving a service instance manually outside of a container using the Service class.

```php
// Resolve directly, outside a container
$service = new Service(\Phalcon\Http\Request::class, true);
$request = $service->resolve();
```

--------------------------------

### Events manager method signatures

Source: https://github.com/phalcon/ide-stubs/blob/master/_autodocs/api-reference/di.md

Methods to get and set the internal events manager. The setter requires a Phalcon Events ManagerInterface instance.

```php
public function getInternalEventsManager(): ManagerInterface|null
public function setInternalEventsManager(\Phalcon\Events\ManagerInterface $eventsManager)
```
Tokens:
Raw