Zend Framework 1 Documentation

When submitting a pull request, ensure you target the appropriate branch based on the nature of your changes:

• master branch: Use this for fixes against the stable release.
• develop branch: Use this for new features or fixes that introduce new elements to the public API (e.g., new public methods or properties).

Zend_EventManager is a component used to manage event-driven logic. It allows you to:

• Attach and detach listeners to named events.
• Manage listeners on a per-instance basis or via shared collections.
• Trigger events.
• Interrupt the execution of listeners.

To have your contributions accepted, you must have a signed Contributor License Agreement (CLA) on file. The project verifies your CLA status by matching your Git commit email to the email used during CLA registration.

If your GitHub username does not match your old Zend Framework issue tracker (JIRA) username, you must explicitly set your local Git email to match your CLA email.

% git config user.email "your-email@example.org"

Zend Framework does not require a complex installation process. To install it:

1. Download the framework distribution.
2. Extract the contents to your desired directory.
3. Add the framework's library directory to your PHP include_path.

Note on Extras: If you intend to use components from the extras library, you must also add the extras/library directory to your PHP include_path.

Note on Zend_Tool: To use Zend_Tool, add the following files to your system's executable path:

• Windows: bin/zf.bat
• Linux/macOS/Other: bin/zf.sh

The documentation is written in Docbook XML. To build the source XML into HTML, you need a Unix-like operating system with the standard GNU toolchain and an XSLT processor like xsltproc.

To compile the documentation, navigate to the directory containing manual.xml and execute the following commands:

1. autoconf
2. ./configure
3. make

$ autoconf
$ ./configure
$ make

After your changes have been merged into the canonical repository, clean up your branches to maintain a tidy workspace.

# Remove a local branch
% git branch -d <branchname>

# Remove a remote branch
% git push origin :<branchname>

The recommended workflow for implementing features or bugfixes is to use dedicated branches for each task. This facilitates code review and merging.

1. Create a new local branch from master.
2. Commit your changes.
3. Push the branch to your remote repository.
4. Submit a pull request (via GitHub) or send an email to <zf-devteam@zend.com> with the repository URL, branch name, and description of changes.

% git checkout -b zf9295
# ... work and commit ...
% git push origin HEAD:zf9295

To run tests, navigate to the tests directory within the VM and use phpunit. It is recommended to use the --stderr flag and increase the memory_limit to ensure tests complete successfully.

Example commands:

cd /vagrant/tests
phpunit --stderr -d memory_limit=-1 Zend/Acl/AclTest.php
phpunit --stderr -d memory_limit=-1 Zend/Amf/AllTests.php

If you need to preview enhancements or bug fixes not yet released, you can use Git or Subversion.

Using Git

The Zend Framework 1.X git repository is available at: https://github.com/zendframework/zf1

To update a local working copy, use:

git fetch && git rebase origin/master

Using Subversion

For versions 1.12.0 and later, use these URLs:

• Development version: https://github.com/zendframework/zf1/trunk
• Release tags: https://github.com/zendframework/zf1/tags/release-1.12.{maintenance version}
• Extras trunk: https://github.com/zendframework/zf1-extras/trunk