ZF1-Future Documentation

For instructions on using the framework, refer to the official manual:

• New ZF1-Future Manual: https://zf1future.com/manual
• Original ZF1 Docs (Legacy): https://framework.zend.com/manual/1.12/en/manual.html

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

On Windows, you can use Cygwin to provide this environment.

If you are hosting your own repository (e.g., using gitosis or gitolite), follow these steps to initialize it and sync with the ZF repository:

1. Initialize a new repository.
2. Add an origin remote pointing to your hosted repository.
3. Add a remote named zf1 pointing to the canonical ZF repository and fetch its content.
4. Create a local branch zf/master tracking the canonical master.
5. Create your own master branch based on the ZF branch and push it to your origin.

% git init
% git remote add origin git://yourdomain/yourrepo.git
% git remote add zf1 https://github.com/zendframework/zf1.git
% git fetch zf1
% git checkout -b zf/master zf1/master
% git checkout -b master
% git push origin HEAD:master

You can set up a development virtual machine for ZF1 unit testing and library development using Vagrant and VirtualBox. The repository you clone will be mounted inside the VM at /vagrant, allowing you to use your local IDE to edit files while the VM handles the execution environment.

Port Forwarding:

• SSH: 22 -> 2222 (localhost)
• HTTP: 80 -> 8081 (localhost)

# 1. Install requirements (Local Machine)
# Install VirtualBox, Ruby, and Vagrant

# 2. Clone the repository
git clone git://github.com/zendframework/zf1.git zf1-dev
cd zf1-dev

# 3. Start the VM
vagrant up

# 4. Access the VM
vagrant ssh

To synchronize your local master branch with the latest changes from the canonical ZF repository, use the zf1 remote to pull changes and then push them to your own remote (origin).

% git checkout master
% git pull zf1 master
% git push origin master

To contribute to the project using GitHub, follow these steps to create a fork and link it to the canonical repository:

1. Fork the ZF1 repository at http://github.com/zendframework/zf1.
2. Clone your fork locally.
3. Add a remote named zf1 pointing to the canonical repository to keep your fork up-to-date.

This setup allows you to fetch updates from the main project and push your own changes to your fork for peer review.

# Clone your fork
% git clone git@github.com:<username>/zf1.git
% cd zf1

# Add the canonical remote
% git remote add zf1 https://github.com/zendframework/zf1.git
% git fetch zf1

Zend Framework requires PHP 7.3 or later.

Note: While the original documentation references older requirements, this version (zf1-future) is specifically maintained for modern PHP environments including PHP 8.2.

To ensure your contributions are accepted, you must have a signed Contributor License Agreement (CLA) on file. The project verifies your CLA status by matching your GitHub username or your Git user email with the email used during CLA registration.

If your GitHub username does not match your CLA registration, you must configure your local Git email to match your CLA email:

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

To run tests, navigate to the /vagrant/tests directory inside the VM and use phpunit. It is recommended to use the --stderr flag and increase the memory_limit to avoid issues during large test suites.

Example for a specific test file: phpunit --stderr -d memory_limit=-1 Zend/Acl/AclTest.php

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

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

1. Download the framework distribution.
2. Extract the files to your desired directory.
3. Add the framework's library directory to your PHP include_path.
4. (Optional) If you need components from the extras library, add the extras/library directory to your PHP include_path as well.

To use Zend_Tool, add the following script to your system's executable path:

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

# Example: Adding to system path for Zend_Tool (Linux/macOS)
export PATH="$PATH:/path/to/zf1/bin"

This sample application demonstrates how to use the Zend_Gdata component to communicate with the YouTube Data API. It is designed to be run within a web browser.

Requirements

• PHP: version 5.2.11 or higher.
• Zend Framework Component: Zend_Gdata must be installed.
• YouTube Developer Key: You must obtain a Developer Key from the YouTube dashboard before use.

Application Files

• index.php: The web UI (HTML/PHP).
• operations.php: The core logic that interfaces with the YouTube API.
• video_app.js: JavaScript for the AJAX video list interface.
• video_app.css: Styles for the interface.
• session_details.php: A utility script to view log output and session variables.

Configuration Note

In the current version, the YouTube Developer Key is hard-coded directly in index.php rather than being provided via a form.