Zend Framework Documentation

https://docs.zendframework.com/
Admin
Comprehensive documentation for Zend Framework MVC applications, Expressive, and all components...
Tokens:728,929
Snippets:8,015
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Composer Install Output Example

Source: https://docs.zendframework.com/tutorials/getting-started/skeleton-application

Example output from Composer during dependency installation, showing package installation and autoload file generation.

```text
Installing dependencies from lock file
- Installing zendframework/zend-component-installer (0.2.0)

... 

Generating autoload files
```

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

### Install All Required Packages for CLI Example

Source: https://docs.zendframework.com/zend-validator/validators/undisclosed-password

Installs all necessary packages for the command-line example, including HTTP client, factories, and the validator itself.

```bash
$ composer require \
    php-http/message \
    php-http/message-factory \
    php-http/discovery \
    php-http/curl-client \
    zendframework/zend-diactoros \
    zendframework/zend-validator
```

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

### File Transport Configuration

Source: https://docs.zendframework.com/zend-mail/transport/file-options

Quick start example demonstrating how to set up the File transport with custom path and callback options.

```APIDOC
## File Transport Configuration

### Description

This section provides a quick start example for configuring the `Zend\Mail\Transport\File` transport with specific options.

### Usage

```php
use Zend\Mail\Transport\File as FileTransport;
use Zend\Mail\Transport\FileOptions;

// Setup File transport
$transport = new FileTransport();
$options   = new FileOptions([
    'path'     => 'data/mail/',
    'callback' => function (FileTransport $transport) {
        return 'Message_' . microtime(true) . '_' . mt_rand() . '.txt';
    },
]);
$transport->setOptions($options);
```

### Configuration Options

- **`path`** (string) - Required - The path under which mail files will be written.
- **`callback`** (callable) - Required - A PHP callable to be invoked in order to generate a unique name for a message file. The default callback is `function (Zend\Mail\FileTransport $transport) { return 'ZendMail_' . time() . '_' . mt_rand() . '.tmp'; }`.
```

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

### Basic Plugin Implementation Example

Source: https://docs.zendframework.com/zend-cache/storage/plugin

Demonstrates how to create a custom cache plugin by extending AbstractPlugin. This example shows how to attach listeners to 'getItem.pre' and 'getItem.post' events to log when an item retrieval starts and finishes.

```php
use Zend\Cache\Storage\Event;
use Zend\Cache\Storage\Plugin\AbstractPlugin;
use Zend\EventManager\EventManagerInterface;

class MyPlugin extends AbstractPlugin
{
    protected $handles = [];

    /**
     * Attach to all events this plugin is interested in.
     */
    public function attach(EventManagerInterface $events)
    {
        $this->handles[] = $events->attach('getItem.pre', array($this, 'onGetItemPre'));
        $this->handles[] = $events->attach('getItem.post', array($this, 'onGetItemPost'));
    }

    /**
     * Detach all handlers this plugin previously attached.
     */
    public function detach(EventManagerInterface $events)
    {
        foreach ($this->handles as $handle) {
           $events->detach($handle);
        }
        $this->handles = [];
    }

    public function onGetItemPre(Event $event)
    {
        $params = $event->getParams();
        echo sprintf("Method 'getItem' with key '%s' started\n", $params['key']);
    }

    public function onGetItemPost(Event $event)
    {
        $params = $event->getParams();
        echo sprintf("Method 'getItem' with key '%s' finished\n", $params['key']);
    }
}

// After defining this plugin, we can instantiate and add it to an adapter
// instance:
$plugin = new MyPlugin();
$cache->addPlugin($plugin);

// Now when calling getItem(), our plugin should print the expected output:
$cache->getItem('cache-key');
// Method 'getItem' with key 'cache-key' started
// Method 'getItem' with key 'cache-key' finished

```

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

### Basic Middleware Application Setup

Source: https://docs.zendframework.com/zend-stratigility/usage

This snippet demonstrates the basic setup for a Zend-Stratigility application. It involves creating a MiddlewarePipe, a PSR-7 Server instance, and configuring the server to listen for requests. Ensure you have the necessary components installed via Composer.

```php
use Zend\Stratigility\MiddlewarePipe;
use Zend\Diactoros\Server;

require __DIR__ . '/../vendor/autoload.php';

$app    = new MiddlewarePipe();
$server = Server::createServer(
  [$app, 'handle'],
  $_SERVER,
  $_GET,
  $_POST,
  $_COOKIE,
  $_FILES
);

$server->listen(function ($req, $res) {
  return $res;
});
```

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

### Quick Start: Using PluginClassLoader

Source: https://docs.zendframework.com/zend-loader/plugin-class-loader

Instantiate a PluginClassLoader, seed it with plugin/class name associations, and use it to retrieve class names. This example demonstrates adding a static map and registering a new plugin.

```php
use Zend\Http\HeaderLoader;

// Provide a global map, or override defaults:
HeaderLoader::addStaticMap([
    'xrequestedfor' => 'My\Http\Header\XRequestedFor',
]);

// Instantiate the loader:
$loader = new Zend\Http\HeaderLoader();

// Register a new plugin:
$loader->registerPlugin('xForwardedFor', 'My\Http\Header\XForwardedFor');

// Load/retrieve the associated plugin class:
$class = $loader->load('xrequestedfor'); // 'My\Http\Header\XRequestedFor'
```

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

### JSON Configuration Example

Source: https://docs.zendframework.com/zend-config/reader

Example of a JSON configuration file structure.

```json
{
  "webhost"  : "www.example.com",
  "database" : {
    "adapter" : "pdo_mysql",
    "params"  : {
      "host"     : "db.example.com",
      "username" : "dbuser",
      "password" : "secret",
      "dbname"   : "dbproduction"
    }
  }
}
```

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

### XML Configuration Example

Source: https://docs.zendframework.com/zend-config/reader

Example of an XML configuration file structure.

```xml
<?xml version="1.0" encoding="utf-8"?>
<config>
    <webhost>www.example.com</webhost>
    <database>
        <adapter value="pdo_mysql"/>
        <params>
            <host value="db.example.com"/>
            <username value="dbuser"/>
            <password value="secret"/>
            <dbname value="dbproduction"/>
        </params>
    </database>
</config>
```

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

### Install slim/flash

Source: https://docs.zendframework.com/zend-expressive/cookbook/flash-messengers

Install the slim/flash package using Composer.

```bash
$ composer require slim/flash
```

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

### Install zend-navigation

Source: https://docs.zendframework.com/tutorials/navigation

Install the zend-navigation component using Composer.

```bash
$ composer require zendframework/zend-navigation
```

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

### CLI Example Output

Source: https://docs.zendframework.com/zend-validator/validators/undisclosed-password

The expected output when running the command-line example script.

```text
Password "password" is disclosed
Password "NVt3MpvQ" is not disclosed
```

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

### Install zend-expressive-authentication-zendauthentication

Source: https://docs.zendframework.com/zend-expressive-authentication-zendauthentication

Install the package using Composer.

```bash
$ composer require zendframework/zend-expressive-authentication-zendauthentication
```

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

### Install zend-expressive-helpers

Source: https://docs.zendframework.com/zend-expressive/features/helpers/intro

Install the zend-expressive-helpers package using Composer.

```bash
$ composer require zendframework/zend-expressive-helpers
```

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

### Start Vagrant Environment

Source: https://docs.zendframework.com/tutorials/getting-started/skeleton-application

Starts the virtual machine environment defined by the Vagrantfile.

```bash
$ vagrant up
```

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

### PhpFileProvider Example

Source: https://docs.zendframework.com/zend-config-aggregator/config-providers

Demonstrates loading configuration from a single PHP file that returns an array.

```php
return [
    'db' => [
        'dsn' => 'mysql:...',
    ],
];
```

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

### Install Dependencies from Lock File

Source: https://docs.zendframework.com/tutorials/getting-started/skeleton-application

Installs project dependencies using Composer, starting from a downloaded ZIP archive.

```bash
$ composer self-update
$ composer install
```

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

### Install zend-expressive-helpers

Source: https://docs.zendframework.com/zend-expressive/v3/features/helpers/intro

Install the zend-expressive-helpers package using Composer. This is typically already included if you started with the Expressive skeleton package.

```bash
composer require zendframework/zend-expressive-helpers
```

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

### Starting the server in v1

Source: https://docs.zendframework.com/zend-expressive-swoole/v2/migration

In version 1, the web server was executed via the entry script.

```bash
$ php public/index.php start
```

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

### Basic MiddlewarePipe Setup

Source: https://docs.zendframework.com/zend-stratigility/middleware

Demonstrates setting up a MiddlewarePipe with landing page, path-specific, and not-found handlers. Middleware can complete the response or delegate to the next handler.

```php
use Zend\Diactoros\Response;
use Zend\Diactoros\Server;
use Zend\Stratigility\Middleware\NotFoundHandler;
use Zend\Stratigility\MiddlewarePipe;

use function Zend\Stratigility\middleware;
use function Zend\Stratigility\path;

require __DIR__ . '/../vendor/autoload.php';

$app = new MiddlewarePipe();

$server = Server::createServer([$app, 'handle'], $_SERVER, $_GET, $_POST, $_COOKIE, $_FILES);

// Landing page
$app->pipe(middleware(function ($req, $handler) {
    if (! in_array($req->getUri()->getPath(), ['/', ''], true)) {
        return $handler->handle($req);
    }

    $response = new Response();
    $response->getBody()->write('Hello world!');

    return $response;
}));

// Another page
$app->pipe(path('/foo', middleware(function ($req, $handler) {
    $response = new Response();
    $response->getBody()->write('FOO!');

    return $response;
})));

// 404 handler
$app->pipe(new NotFoundHandler(function () {
    return new Response();
}));

$server->listen(function ($req, $res) {
    return $res;
});
```

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

### Custom Scrolling Style: Get Pages Example

Source: https://docs.zendframework.com/zend-paginator/advanced

Example of how to implement the getPages() method for a custom scrolling style, returning the calculated page range.

```php
return $paginator->getPagesInRange($lowerBound, $upperBound);
```

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

### Custom Data Source Adapter: Get Items Example

Source: https://docs.zendframework.com/zend-paginator/advanced

Example of how to implement the getItems() method for a custom data source adapter, returning a slice of data.

```php
return array_slice($this->array, $offset, $itemCountPerPage);
```

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

### Basic Metadata Retrieval Example

Source: https://docs.zendframework.com/zend-db/metadata

Demonstrates how to instantiate the Metadata class and retrieve table names, columns, and constraints. Requires an existing Adapter instance.

```php
$metadata = new Zend\Db\Metadata\Metadata($adapter);

// get the table names
$tableNames = $metadata->getTableNames();

foreach ($tableNames as $tableName) {
    echo 'In Table ' . $tableName . PHP_EOL;

    $table = $metadata->getTable($tableName);

    echo '    With columns: ' . PHP_EOL;
    foreach ($table->getColumns() as $column) {
        echo '        ' . $column->getName()
            . ' -> ' . $column->getDataType()
            . PHP_EOL;
    }

    echo PHP_EOL;
    echo '    With constraints: ' . PHP_EOL;

    foreach ($metadata->getConstraints($tableName) as $constraint) {
        echo '        ' . $constraint->getName()
            . ' -> ' . $constraint->getType()
            . PHP_EOL;

        if (! $constraint->hasColumns()) {
            continue;
        }

        echo '            column: ' . implode(', ', $constraint->getColumns());
        if ($constraint->isForeignKey()) {
            $fkCols = [];
            foreach ($constraint->getReferencedColumns() as $refColumn) {
                $fkCols[] = $constraint->getReferencedTableName() . '.' . $refColumn;
            }
            echo ' => ' . implode(', ', $fkCols);
        }

        echo PHP_EOL;
    }

    echo '----' . PHP_EOL;
}
```

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

### Instantiate and Show Confirm Prompt

Source: https://docs.zendframework.com/zend-console/prompts

Demonstrates how to create a Confirm prompt instance and display it to the user.

```php
use Zend\Console\Prompt;

$confirm = new Prompt\Confirm('Are you sure you want to continue?');
$result = $confirm->show();
if ($result) {
    // the user chose to continue
}
```

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

### Get SOAP Integer Type

Source: https://docs.zendframework.com/zend-soap/wsdl

Retrieves the SOAP type mapping for a given PHP type using the Zend\Soap\Wsdl class. This example shows how to get the SOAP type for an integer.

```php
<?php

$wsdl = new Zend\Soap\Wsdl('My_Web_Service', $myWebServiceUri);
$soapIntType = $wsdl->getType('int');

class MyClass
{
    /* ... */
}

$soapMyClassType = $wsdl->getType('MyClass');
?>
```

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

### Setup File Transport

Source: https://docs.zendframework.com/zend-mail/transport/file-options

Demonstrates how to set up the File transport with a custom path and a callback for generating unique message filenames.

```php
use Zend\Mail\Transport\File as FileTransport;
use Zend\Mail\Transport\FileOptions;

// Setup File transport
$transport = new FileTransport();
$options   = new FileOptions([
    'path'     => 'data/mail/',
    'callback' => function (FileTransport $transport) {
        return 'Message_' . microtime(true) . '_' . mt_rand() . '.txt';
    },
]);
$transport->setOptions($options);
```

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

### Configuration at Instantiation

Source: https://docs.zendframework.com/zend-loader/standard-autoloader

Shows how to configure the StandardAutoloader by passing an array of options directly to the constructor, equivalent to manual configuration.

```php
use Zend\Loader\StandardAutoloader;

$loader = new StandardAutoloader([
    'namespaces' => [
        'Phly' => APPLICATION_PATH . '/../library/Phly',
    ],
    'prefixes' => [
        'Scapi' => APPLICATION_PATH . '/../library/Scapi',
    ],
    'fallback_autoloader' => true,
]);

// Register with spl_autoload:
$loader->register();
```

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

### Basic Server Initialization and Handling

Source: https://docs.zendframework.com/zend-json-server/usage

Initialize the JSON-RPC server, make a class available, and handle incoming requests. This is the minimal setup for a functional server.

```php
$server = new Zend\Json\Server\Server();

// Indicate what functionality is available:
$server->setClass('Calculator');

// Handle the request:
$server->handle();
```

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

### Create Expressive Skeleton Project

Source: https://docs.zendframework.com/zend-di/cookbook/aot-guide

Use composer to create a new Expressive application skeleton. This is the starting point for the guide.

```bash
$ composer create-project zendframework/zend-expressive-skeleton zend-di-aot-example
```

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

### Manually Create Generator Instance (Pre-v3.1)

Source: https://docs.zendframework.com/zend-di/cookbook/aot-guide

Example demonstrating manual creation of `InjectorGenerator` before version 3.1, including dependency setup.

```php
namespace AppAoT;

use Psr\Container\ContainerInterface;
use Zend\Code\Scanner\DirectoryScanner;
use Zend\Di\CodeGenerator\InjectorGenerator;
use Zend\Di\Config;
use Zend\Di\ConfigInterface;
use Zend\Di\Definition\RuntimeDefinition;
use Zend\Di\Resolver\DependencyResolver;

require __DIR__ . '/../vendor/autoload.php';

$directories = [
    __DIR__ . '/../src/App/src',
];

// Generator dependencies. You might put this in a service factory
// in a real-life scenario.

/** @var ContainerInterface $container */
$container = require __DIR__ . '/../config/container.php';
$config = $container->get(ConfigInterface::class);
$resolver = new DependencyResolver(new RuntimeDefinition(), $config);

// This is important; we want to use configured aliases of the service manager.
$resolver->setContainer($container);

$scanner = new DirectoryScanner($directories);
$generator = new InjectorGenerator($config, $resolver, __NAMESPACE__ . '\\Generated');
$generator->setOutputDirectory(__DIR__ . '/../src/AppAoT/gen');
$generator->generate($scanner->getClassNames());
```

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

### Install Skeleton Application via Docker Compose

Source: https://docs.zendframework.com/tutorials/getting-started/skeleton-application

Alternatively, use Docker Compose to manage the environment and run Composer for the skeleton application setup.

```bash
docker-compose up
docker-compose exec --user www-data php bash
cd /var/www/html/zf-tutorial
```

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

### Basic Collection Element Setup

Source: https://docs.zendframework.com/zend-form/element/collection

Demonstrates how to create a collection element with a specified count and target element using object instantiation.

```php
use Zend\Form\Element;
use Zend\Form\Form;

$colors = new Element\Collection('collection');
$colors->setLabel('Colors');
$colors->setCount(2);
$colors->setTargetElement(new Element\Color());
$colors->setShouldCreateTemplate(true);

$form = new Form('my-form');
$form->add($colors);
```

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

### Instantiate ObjectCache Pattern

Source: https://docs.zendframework.com/zend-cache/pattern/object-cache

Quick start example showing how to create an instance of the ObjectCache pattern using PatternFactory. It requires an object to cache and a storage adapter.

```php
use stdClass;
use Zend\Cache\PatternFactory;

$object      = new stdClass();
$objectCache = PatternFactory::factory('object', [
    'object'  => $object,
    'storage' => 'apc'
]);
```

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

### System Configuration Example

Source: https://docs.zendframework.com/tutorials/advanced-config

This is the default system configuration for the skeleton application, defining module paths, configuration glob paths, and caching options.

```php
return [
    // Retrieve list of modules used in this application.
    'modules' => require __DIR__ . '/modules.config.php',

    // These are various options for the listeners attached to the ModuleManager
    'module_listener_options' => [
        // This should be an array of paths in which modules reside.
        // If a string key is provided, the listener will consider that a module
        // namespace, the value of that key the specific path to that module's
        // Module class.
        'module_paths' => [
            './module',
            './vendor',
        ],

        // An array of paths from which to glob configuration files after
        // modules are loaded. These effectively override configuration
        // provided by modules themselves. Paths may use GLOB_BRACE notation.
        'config_glob_paths' => [
            realpath(__DIR__) . '/autoload/{{,*.}global,{,*.}local}.php',
        ],

        // Whether or not to enable a configuration cache.
        // If enabled, the merged configuration will be cached and used in
        // subsequent requests.
        'config_cache_enabled' => true,

        // The key used to create the configuration cache file name.
        'config_cache_key' => 'application.config.cache',

        // Whether or not to enable a module class map cache.
        // If enabled, creates a module class map cache which will be used
        // by in future requests, to reduce the autoloading process.
        'module_map_cache_enabled' => true,

        // The key used to create the class map cache file name.
        'module_map_cache_key' => 'application.module.cache',

        // The path in which to cache merged configuration.
        'cache_dir' => 'data/cache/',

        // Whether or not to enable modules dependency checking.
        // Enabled by default, prevents usage of modules that depend on other modules
        // that weren't loaded.
        // 'check_dependencies' => true,
    ],

    // Used to create an own service manager. May contain one or more child arrays.
    // 'service_listener_options' => [
    //     [
    //         'service_manager' => $stringServiceManagerName,
    //         'config_key'      => $stringConfigKey,
    //         'interface'       => $stringOptionalInterface,
    //         'method'          => $stringRequiredMethodName,
    //     ],
    // ],

    // Initial configuration with which to seed the ServiceManager.
    // Should be compatible with Zend
    //ServiceManager\Config.
    // 'service_manager' => [],
];

```

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

### Retrieve and Inject Input Filter in Controller Factory

Source: https://docs.zendframework.com/zend-inputfilter/specs

Example of a controller factory that retrieves the InputFilterManager and gets a specific input filter ('foobar') to inject into a controller.

```php
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class MyValidatingControllerFactory implements FactoryInterface
{
    public function createService(ServiceLocatorInterface $controllers)
    {
        // Retrieve the application service manager
        $services = $controllers->getServiceLocator();

        // Retrieve the InputFilterManager
        $filters = $services->get('InputFilterManager');

        // Instantiate the controller and pass it the foobar input filter
        return new MyValidatingController($filters->get('foobar'));
    }
}
```

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

### Basic Post Processor Example

Source: https://docs.zendframework.com/zend-config-aggregator/config-post-processors

Demonstrates adding a simple post processor to append a key-value pair to the merged configuration.

```php
$providers = [
    function () {
        return ['foo' => 'bar'];
    },
    new PhpFileProvider('*.global.php'),
];

$processors = [
    function (array $config) {
        return $config + ['post-processed' => true];
    },
];

$aggregator = new ConfigAggregator($providers, null, $processors);
var_dump($aggregator->getMergedConfig());
```

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

### Example Usage of PRG Plugin in a Controller

Source: https://docs.zendframework.com/zend-mvc-plugin-prg

This example shows how to use the PRG plugin in a Zend MVC controller. It handles POST requests by storing data and redirecting, and processes the data when the GET request is received. It also covers cases where the request is not a POST or when no previous POST data exists.

```php
// Pass in the route/url you want to redirect to after the POST
$prg = $this->prg('/user/register', true);

if ($prg instanceof \Zend\Http\PhpEnvironment\Response) {
    // Returned a response to redirect us.
    return $prg;
}

if ($prg === false) {
    // This wasn't a POST request, but there were no params in the flash
    // messenger; this is probably the first time the form was loaded.
    return ['form' => $myForm];
}

// $prg is an array containing the POST params from the previous request
$form->setData($prg);

// ... your form processing code here

```

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

### Registering LoggerAbstractServiceFactory

Source: https://docs.zendframework.com/zend-log/service-manager

Register the abstract factory in your service manager configuration to enable logger setup via configuration. This is often handled automatically by installers or module registration.

```php
// module.config.php
return [
    'service_manager' => [
        'abstract_factories' => [
            'Zend\Log\LoggerAbstractServiceFactory',
        ],
    ],
];
```

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

### Manually Instantiating Cache and Plugin

Source: https://docs.zendframework.com/zend-cache/storage/plugin

Illustrates the manual instantiation of a cache adapter and a plugin, followed by adding the plugin to the adapter.

```php
// Or manually:
$cache  = new Zend\Cache\Storage\Adapter\Filesystem();
$plugin = new Zend\Cache\Storage\Plugin\Serializer();
$cache->addPlugin($plugin);
```

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

### Example Injector Configuration

Source: https://docs.zendframework.com/zend-di/config

Demonstrates how to create a Zend
Di
Config object with global preferences and type definitions, including aliases.

```php
$config = new \Zend\Di\Config([
    // Declares global preferences to use when resolving
    // dependencies of the specified type
    'preferences' => [
        // A map of classname => preferred type
        MyInterface::class => MyImplementation::class,
    ],

    // Declares how types should be constructed.
    // This also allows declaring aliases of a specific class
    'types' => [
        ClassName::class => [
            // Declaration in the same way as global preferences
            // but these will aply when the type of the associated key
            // should be instanciated
            'preferences' => [],

            // Constructor parameters to inject. This option will define
            // the injections directly by the parameter name of the constructor
            // used as key.
            //
            // If the parameter is type-hinted by a class/interface name, you can
            // provide the injection by string. The injector will use the IoC
            // container to obtain it.
            'parameters' => [
                'foo' => 'bar',
            ],
        ],

        // Define an alias
        'Alias.Name' => [
            'typeOf' => ClassName::class,

            'preferences' => [],
            'parameters' => [],
        ],
    ],
]);
```

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

### Attaching a Listener Aggregate

Source: https://docs.zendframework.com/zend-eventmanager/examples

This example demonstrates how to instantiate a class that uses caching and attach a CacheListener aggregate to its event manager. This setup enables the caching mechanism when the class's methods are called.

```php
$value         = new SomeValueObject();
$cacheListener = new CacheListener($cache);
$cacheListener->attach($value->getEventManager());
```

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

### HalResponseFactory Initialization with Slim

Source: https://docs.zendframework.com/zend-expressive-hal/representations

Example of creating a HalResponseFactory instance using a Slim Framework response factory.

```php
use Slim\Http\Response;
use Slim\Http\Stream;
use Zend\Expressive\Hal\HalResponseFactory;

$factory = new HalResponseFactory(
    function () {
        return new Response();
    }
);
```

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

### Registering and Using a Custom Feed Reader Extension

Source: https://docs.zendframework.com/zend-feed/reader

This example demonstrates how to install zend-servicemanager, configure an ExtensionManager, register a custom extension ('JungleBooks'), and then use it to import a feed and retrieve custom data like ISBN.

```bash
$ composer require zendframework/zend-servicemanager
```

```php
use My\FeedReader\Extension\JungleBooks;
use Zend\Feed\Reader\ExtensionManager;
use Zend\Feed\Reader\ExtensionPluginManager;
use Zend\Feed\Reader\Reader;

$extensions = new ExtensionPluginManager();
$extensions->setInvokableClass('JungleBooks\Entry', JungleBooks\Entry::class);
Reader::setExtensionManager(new ExtensionManager($extensions));
Reader::registerExtension('JungleBooks');

$feed = Reader::import('http://example.com/junglebooks/rss');

// ISBN for whatever book the first entry in the feed was concerned with
$firstIsbn = $feed->current()->getIsbn();
```

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

### CaptureCache Class Methods

Source: https://docs.zendframework.com/zend-cache/pattern/capture-cache

Defines the available methods for the CaptureCache class, including starting the cache, setting content, retrieving cached pages, checking for existence, removing pages, clearing by glob pattern, and getting the generated filename.

```php
namespace Zend\Cache\Pattern;

use Zend\Cache\Exception;
use Zend\Stdlib\ErrorHandler;

class CaptureCache extends AbstractPattern
{
    /**
     * Start the cache.
     *
     * @param  string $pageId  Page identifier
     * @return void
     */
    public function start($pageId = null);

    /**
     * Write a page to the requested path.
     *
     * @param string      $content
     * @param null|string $pageId
     * @throws Exception\LogicException
     */
    public function set($content, $pageId = null);

    /**
     * Retrieve a generated page from the cache.
     *
     * @param  null|string $pageId
     * @return string|null
     * @throws Exception\LogicException
     * @throws Exception\RuntimeException
     */
    public function get($pageId = null);

    /**
     * Check if a cache exists for the given page.
     *
     * @param  null|string $pageId
     * @throws Exception\LogicException
     * @return bool
     */
    public function has($pageId = null);

    /**
     * Remove a page from the cache.
     *
     * @param  null|string $pageId
     * @throws Exception\LogicException
     * @throws Exception\RuntimeException
     * @return bool
     */
    public function remove($pageId = null);

    /**
     * Clear cached pages that match the specified glob pattern.
     *
     * @param string $pattern
     * @throws Exception\LogicException
     */
    public function clearByGlob($pattern = '**');

    /**
     * Returns the generated file name.
     *
     * @param null|string $pageId
     * @return string
     */
    public function getFilename($pageId = null);
}
```

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

### Run the Command Line Example

Source: https://docs.zendframework.com/zend-validator/validators/undisclosed-password

Executes the PHP script using the PHP command-line interpreter.

```bash
$ php undisclosed.php
```

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

### Basic EventManager Setup and Trigger

Source: https://docs.zendframework.com/tutorials/event-manager

This snippet demonstrates the minimal setup for using events: an EventManager instance, attaching a listener using a closure, and triggering an event with parameters.

```php
use Zend\EventManager\EventManager;

$events = new EventManager();
$events->attach('do', function ($e) {
    $event = $e->getName();
    $params = $e->getParams();
    printf(
        'Handled event "%s", with parameters %s',
        $event,
        json_encode($params)
    );
});

$params = ['foo' => 'bar', 'baz' => 'bat'];
$events->trigger('do', null, $params);
```

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

### Example Usage of File PRG Plugin

Source: https://docs.zendframework.com/zend-mvc-plugin-fileprg

Demonstrates how to use the File PRG plugin in a Zend MVC controller. It shows form setup, attaching a file relocation filter, invoking the plugin, and handling the response for initial load, redirect, or form submission.

```php
$myForm = new Zend\Form\Form('my-form');
$myForm->add([
    'type' => 'Zend\Form\Element\File',
    'name' => 'file',
]);

// NOTE: Without a filter to move the file,
//       our files will disappear between the requests
$myForm->getInputFilter()->getFilterChain()->attach(
    new Zend\Filter\File\RenameUpload([
        'target'    => './data/tmpuploads/file',
        'randomize' => true,
    ])
);

// Pass in the form and optional the route/url you want to redirect to after the POST
$prg = $this->fileprg($myForm, '/user/profile-pic', true);

if ($prg instanceof Zend\Http\PhpEnvironment\Response) {
    // Returned a response to redirect us.
    return $prg;
}

if ($prg === false) {
    // First time the form was loaded.
    return ['form' => $myForm];
}

// Form was submitted.
// $prg is now an array containing the POST params from the previous request,
// but we don't have to apply it to the form since that has already been done.

// Process the form
if ($form->isValid()) {
    // ...Save the form...
    return $this->redirect()->toRoute('/user/profile-pic/success');
}

// Form not valid, but file uploads might be valid and uploaded
$fileErrors = $form->get('file')->getMessages();
if (empty($fileErrors)) {
    $tempFile = $form->get('file')->getValue();
}
```

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

### Getting a Platform Instance

Source: https://docs.zendframework.com/zend-db/adapter

Demonstrates how to obtain a Platform instance from a configured Zend\Db\Adapter\Adapter object.

```php
$platform = $adapter->getPlatform();

// or
$platform = $adapter->platform; // magic property access
```

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

### CaptureCache Methods

Source: https://docs.zendframework.com/zend-cache/pattern/capture-cache

This section details the methods available for the CaptureCache pattern, which extend the base PatternInterface. These methods allow for starting the cache, setting content, retrieving cached pages, checking for existence, removing pages, clearing by glob pattern, and getting the generated filename.

```APIDOC
## CaptureCache Methods

### `start(string $pageId = null)`

Starts the cache process. Optionally accepts a page identifier.

### `set(string $content, null|string $pageId = null)`

Writes content to the cache for a given page identifier. Throws `Exception\LogicException` on failure.

### `get(null|string $pageId = null)`

Retrieves cached content for a given page identifier. Returns the content as a string or null if not found. Throws `Exception\LogicException` or `Exception\RuntimeException` on failure.

### `has(null|string $pageId = null)`

Checks if a cache entry exists for the given page identifier. Throws `Exception\LogicException` on failure.

### `remove(null|string $pageId = null)`

Removes a page from the cache using its identifier. Throws `Exception\LogicException` or `Exception\RuntimeException` on failure.

### `clearByGlob(string $pattern = '**')`

Clears cached pages matching a specified glob pattern. Defaults to clearing all entries. Throws `Exception\LogicException` on failure.

### `getFilename(null|string $pageId = null)`

Returns the file path for the generated cache file associated with the given page identifier.
```

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

### Encrypt and Decrypt Message with PEM Encoded RSA Keys

Source: https://docs.zendframework.com/zend-crypt/hybrid

Encrypts and decrypts a message using RSA keys provided as PEM-encoded strings. This example demonstrates using the `toString()` method to get PEM strings and passing the pass phrase during decryption if the private key is protected.

```php
use Zend\Crypt\Hybrid;
use Zend\Crypt\PublicKey\RsaOptions;

// Generate public and private key
$rsaOptions = new RsaOptions([
    'pass_phrase' => 'test'
]);
$rsaOptions->generateKeys([
    'private_key_bits' => 4096
]);
// Strings in PEM format
$publicKey  = $rsaOptions->getPublicKey()->toString();
$privateKey = $rsaOptions->getPrivateKey()->toString();

$hybrid     = new Hybrid();
$ciphertext = $hybrid->encrypt('message', $publicKey);
$plaintext  = $hybrid->decrypt($ciphertext, $privateKey, 'test'); // pass-phrase

printf($plaintext === 'message' ? "Success\n" : "Error\n");

```

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

### Build and Start Docker Compose Environment

Source: https://docs.zendframework.com/tutorials/getting-started/skeleton-application

Builds the Docker images and starts the containers defined in docker-compose.yml for the first time.

```bash
$ docker-compose up -d --build
```

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

### Minimal Install Prompt

Source: https://docs.zendframework.com/tutorials/getting-started/skeleton-application

The installer prompts whether to perform a minimal installation, excluding optional packages.

```bash
Do you want a minimal install (no optional packages)? Y/n
```

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

### Basic Service Manager Configuration

Source: https://docs.zendframework.com/zend-servicemanager/configuring-the-service-manager

An example demonstrating the structure for configuring a Service Manager instance with various configuration keys.

```php
use Zend\ServiceManager\ServiceManager;

$serviceManager = new ServiceManager([
    'services'           => [],
    'invokables'         => [],
    'factories'          => [],
    'abstract_factories' => [],
    'delegators'         => [],
    'aliases'            => [],
    'initializers'       => [],
    'lazy_services'      => [],
    'shared'             => [],
    'shared_by_default'  => true,
]);
```

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

### Install zend-mvc-console

Source: https://docs.zendframework.com/zend-mvc/migration/to-v3-0

Install the zend-mvc-console component if you were using console tooling in previous versions. Ensure zend-component-installer is already installed.

```bash
$ composer require zendframework/zend-mvc-console
```

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

### Example: Creating Bar with SpecialFoo from IoC

Source: https://docs.zendframework.com/zend-di/injector

Demonstrates creating an instance of `Bar` where the `foo` dependency is resolved from the IoC container as a `SpecialFoo` class.

```php
// Assume the following classes
class Foo
{}

class SpecialFoo extends Foo
{}

class Bar
{
    public function __construct(Foo $foo, $type = null)
    {}
}

// Usage
use Zend\Di\Resolver\ValueInjection;
use Zend\Di\Resolver\TypeInjection;

// Creates Bar with an instance of SpecialFoo from the IoC container:
$injector->create(Bar::class, [
    'foo' => SpecialFoo::class,
]);
```

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

### Install zend-mvc-i18n

Source: https://docs.zendframework.com/tutorials/i18n

Install the zend-mvc-i18n component using Composer. Ensure you select the correct configuration file for module installation if using zend-component-installer.

```bash
$ composer require zendframework/zend-mvc-i18n
```

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

### Database Adapter, Query Preparation, and Execution

Source: https://docs.zendframework.com/zend-db/adapter

Demonstrates creating a database adapter, defining helper functions for quoting identifiers and formatting parameter names, preparing an UPDATE SQL statement, executing it with parameters, and then preparing and executing a SELECT query to fetch the updated data.

```php
$adapter = new Zend\Db\Adapter\Adapter($driverConfig);

$qi = function ($name) use ($adapter) {
    return $adapter->platform->quoteIdentifier($name);
};
$fp = function ($name) use ($adapter) {
    return $adapter->driver->formatParameterName($name);
};

$sql = 'UPDATE ' . $qi('artist')
    . ' SET ' . $qi('name') . ' = ' . $fp('name')
    . ' WHERE ' . $qi('id') . ' = ' . $fp('id');

$statement = $adapter->query($sql);

$parameters = [
    'name' => 'Updated Artist',
    'id'   => 1,
];

$statement->execute($parameters);

// DATA INSERTED, NOW CHECK

$statement = $adapter->query(
    'SELECT * FROM '
    . $qi('artist')
    . ' WHERE id = ' . $fp('id')
);

$results = $statement->execute(['id' => 1]);

$row = $results->current();
$name = $row['name'];

```

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

### Basic MiddlewarePipe Setup

Source: https://docs.zendframework.com/zend-stratigility/executing-middleware

Demonstrates creating a MiddlewarePipe for API middleware and attaching it to the main application pipe using a PathMiddlewareDecorator.

```php
$api = new MiddlewarePipe();  // API middleware collection
$api->pipe(/* ... */);        // repeat as necessary

$app = new MiddlewarePipe();  // Middleware representing the application
$app->pipe(new PathMiddlewareDecorator('/api', $api)); // API middleware attached to the path "/api"
```

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

### Install Skeleton Application via Vagrant

Source: https://docs.zendframework.com/tutorials/getting-started/skeleton-application

If Composer is not installed directly, you can use Vagrant to run the Composer installation process within a virtual environment.

```bash
vagrant up
vagrant ssh
cd /var/www/html/zf-tutorial
```

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

### Example PHP Configuration File

Source: https://docs.zendframework.com/zend-config-aggregator/intro

Illustrates the expected format for PHP configuration files used with PhpFileProvider. Each file must return a PHP array representing a part of the application's configuration.

```php
// db.global.php
return [
    'db' => [
        'dsn' => 'mysql:...',
    ],
];
```

```php
// cache.global.php
return [
    'cache_storage' => 'redis',
    'redis' => [ ... ],
];
```

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

### Install zend-expressive-authentication

Source: https://docs.zendframework.com/zend-expressive-authentication

Install the zend-expressive-authentication package using Composer.

```bash
$ composer require zendframework/zend-expressive-authentication
```

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

### Basic Date Formatting Examples

Source: https://docs.zendframework.com/zend-i18n/view-helpers

Demonstrates how to format dates and times using various predefined styles and locales.

```php
echo $this->dateFormat(
    new DateTime(),
    IntlDateFormatter::MEDIUM, // date
    IntlDateFormatter::MEDIUM, // time
    "en_US"
);
// This returns: "Jul 2, 2012 6:44:03 PM"
```

```php
echo $this->dateFormat(
    new DateTime(),
    IntlDateFormatter::LONG, // date
    IntlDateFormatter::NONE, // time
    "en_US"
);
// This returns: "July 2, 2012"
```

```php
echo $this->dateFormat(
    new DateTime(),
    IntlDateFormatter::NONE,  // date
    IntlDateFormatter::SHORT, // time
    "en_US"
);
// This returns: "6:44 PM"
```

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

### Install zend-console

Source: https://docs.zendframework.com/zend-console

Use Composer to install the zend-console package.

```bash
$ composer require zendframework/zend-console
```

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

### HelloWorld Class Example

Source: https://docs.zendframework.com/zend-stdlib/console-helper

An example class demonstrating the usage of ConsoleHelper for argument validation and outputting formatted messages to the console.

```php
namespace Foo;

use Zend\Stdlib\ConsoleHelper;

class HelloWorld
{
    private $helper;

    public function __construct(ConsoleHelper $helper = null)
    {
        $this->helper = $helper ?: new ConsoleHelper();
    }

    public function __invoke(array $args)
    {
        if (! count($args)) {
            $this->helper->writeErrorMessage('Missing arguments!');
            return;
        }

        if (count($args) > 1) {
            $this->helper->writeErrorMessage('Too many arguments!');
            return;
        }

        $target = array_shift($args);

        $this->helper->writeLine(sprintf(
            '<info>Hello</info> %s',
            $target
        ));
    }
}
```

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

### Quick Start: Registering a Class Map

Source: https://docs.zendframework.com/zend-loader/class-map-autoloader

Instantiate ClassMapAutoloader, provide the path to a class map file, and register it with spl_autoload.

```php
use Zend\Loader\ClassMapAutoloader;

$loader = new ClassMapAutoloader();

// Register the class map:
$loader->registerAutoloadMap('Some/Directory/autoload_classmap.php');

// Register with spl_autoload:
$loader->register();
```

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

### Install zend-expressive-swoole Package

Source: https://docs.zendframework.com/zend-expressive-swoole/intro

Install the zend-expressive-swoole package using Composer.

```bash
$ composer require zendframework/zend-expressive-swoole
```

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

### Version 2 Initializer Example

Source: https://docs.zendframework.com/zend-servicemanager/migration

A sample initializer implementation for version 2, demonstrating setter injection.

```php
use Zend\ServiceManager\InitializerInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class FooInitializer implements InitializerInterface
{
    public function initializer($instance, ServiceLocatorInterface $services)
    {
        if (! $instance implements FooAwareInterface) {
            return $instance;
        }
        $instance->setFoo($services->get(FooInterface::class);
        return $instance;
    }
}
```

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

### Install zend-expressive-session

Source: https://docs.zendframework.com/zend-expressive-session/intro

Install the core zend-expressive-session package using Composer.

```bash
$ composer require zendframework/zend-expressive-session
```

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

### Config Provider Class Example

Source: https://docs.zendframework.com/zend-component-installer

Example of a configuration provider class with an __invoke method returning a configuration array.

```php
namespace Some\Component;

class ConfigProvider
{
    public function __invoke()
    {
        return [ /* ... */ ];
    }
}
```

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

### Install zend-expressive-authentication-session with Composer

Source: https://docs.zendframework.com/zend-expressive-authentication-session

Use Composer to install the zend-expressive-authentication-session package.

```bash
$ composer require zendframework/zend-expressive-authentication-session
```

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

### Example Controller Output

Source: https://docs.zendframework.com/zend-mvc/quick-start

This is the expected HTML output when accessing the '/hello/world' route without any query parameters.

```html
<h1>Greetings!</h1>

<p>You said "foo".</p>
```

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

### Install zend-expressive-platesrenderer

Source: https://docs.zendframework.com/zend-expressive/v3/features/template/plates

Install the Plates renderer integration using Composer.

```bash
composer require zendframework/zend-expressive-platesrenderer
```

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

### Basic Element and Form Setup

Source: https://docs.zendframework.com/zend-form/element/element

Demonstrates the minimum requirements for creating form elements (Text and Password) and adding them to a Form object. This includes setting names, labels, and attributes.

```php
use Zend\Form\Element;
use Zend\Form\Form;

$username = new Element\Text('username');
$username->setLabel('Username');
$username->setAttributes([
    'class' => 'username',
    'size'  => '30',
]);

$password = new Element\Password('password');
$password->setLabel('Password')
$password->setAttributes([
    'size'  => '30',
]);

$form = new Form('my-form');
$form->add($username);
$form->add($password);
```

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

### Install zend-expressive-fastroute

Source: https://docs.zendframework.com/zend-expressive/features/router/fast-route

Install the FastRoute integration package using Composer.

```bash
$ composer require zendframework/zend-expressive-fastroute
```

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

### Typical Module Class with Configuration and Autoloader

Source: https://docs.zendframework.com/zend-modulemanager/module-class

A more complete example of a Module class, demonstrating how to provide autoloader configuration and application configuration.

```php
namespace MyModule;

class Module
{
    public function getAutoloaderConfig()
    {
        return [
            'Zend\Loader\ClassMapAutoloader' => [
                __DIR__ . '/autoload_classmap.php',
            ],
            'Zend\Loader\StandardAutoloader' => [
                'namespaces' => [
                    __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__,
                ],
            ],
        ];
    }

    public function getConfig()
    {
        return include __DIR__ . '/config/module.config.php';
    }
}
```

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

### Install zend-servicemanager-di

Source: https://docs.zendframework.com/zend-mvc/migration/to-v3-0

Install the zend-servicemanager-di component to restore integration between zend-servicemanager and zend-di.

```bash
$ composer require zendframework/zend-servicemanager-di
```

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

### Install Zend HttpHandlerRunner

Source: https://docs.zendframework.com/zend-httphandlerrunner/usage

Install the package using the Composer dependency manager.

```bash
$ composer require zendframework/zend-httphandlerrunner
```

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

### Install zend-hydrator

Source: https://docs.zendframework.com/zend-expressive-hal/intro

Install the zend-hydrator package using Composer for object extraction.

```bash
$ composer require zendframework/zend-hydrator
```
Tokens:
Raw