Creating and Running a PHPixie Project

What is PHPixie?

PHPixie is a lightweight PHP framework designed for rapid development of high-performance web applications. It follows the HMVC (Hierarchical Model-View-Controller) design pattern, providing a clean code structure and high performance. PHPixie is known for its simplicity, flexibility, and high performance, making it a popular choice among developers.

Main Features and Benefits of PHPixie

• Lightweight: PHPixie's core system is very small, containing only essential components, and is extremely fast to load.
• High Performance: Known for its efficient performance and speed, PHPixie can handle high concurrent requests.
• Easy to Learn: With a simple and easy-to-use API and comprehensive documentation, developers can quickly get started.
• Flexibility: It allows developers to choose and use third-party libraries and plugins freely, making it easy to extend and customize functionalities.
• Strong Community Support: PHPixie has an active developer community and a wealth of third-party extensions.

PHPixie can help developers quickly build high-performance, high-quality web applications suitable for projects of all sizes.

Creating and Running a PHPixie Project Using ServBay

In this article, we'll create and run a PHPixie project using the PHP environment provided by ServBay. We'll use ServBay's 'Host' feature to set up the web server and configure project access with minimal effort.

Note: If you've been a user of NGINX or Apache

ServBay uses Caddy as its default web server. If you're transitioning from NGINX or Apache to ServBay, there are some key changes to note:

1. Caddy Configuration

   ServBay comes with Caddy pre-installed, and the default configuration has been optimized and debugged. Developers can manage sites through ServBay’s 'Host' feature without manually modifying the Caddy configuration file.

2. Rewrite Rules and .htaccess

   In NGINX and Apache, developers typically write their own rewrite rules and .htaccess files to handle URL rewriting and other configurations. However, ServBay comes with pre-configured Caddy rules, so you don't need to write these rules yourself unless you have specific requirements.

3. Learn More

   For more information, please refer to Rewrite and htaccess, How to Migrate Apache Sites to ServBay, and How to Migrate NGINX Sites to ServBay.

Creating a PHPixie Project

TIP

ServBay recommends developers place websites in the /Applications/ServBay/www directory for easier management.

1. Install Composer

   Composer comes pre-installed with ServBay, so there's no need to install it separately.

2. Create a PHPixie Project

   Use Composer to create a new PHPixie project:

   cd /Applications/ServBay/www
   mkdir servbay-phpixie-app
   cd servbay-phpixie-app
   composer create-project phpixie/project .

3. Enter the Project Directory

   Navigate to the newly created PHPixie project directory:

   cd /Applications/ServBay/www/servbay-phpixie-app

Initial Configuration

1. Configure Database Connection

   In the assets/config/database.php file, configure the database connection information:

   return [
       'default' => [
           'driver'    => 'pdo',
           'connection' => 'mysql:host=127.0.0.1;dbname=servbay_phpixie_app',
           'user'      => 'root',
           'password'  => 'password',
           'options'   => []
       ]
   ];

Configuring the Web Server

Use ServBay's 'Host' feature to access the PHPixie project via the web server. In ServBay's 'Host' settings, add a new host:

• Name: My First PHPixie Dev Site
• Domain: servbay-phpixie-test.local
• Site Type: PHP
• PHP Version: Select 8.3
• Root Directory: /Applications/ServBay/www/servbay-phpixie-app/web

For detailed setup steps, please refer to Adding Your First Site.

Adding Sample Code

In the src/App/HTTP/Controller/Home.php file, add the following code:

namespace App\HTTP\Controller;

use PHPixie\HTTP\Request;
use PHPixie\Template;

class Home extends \PHPixie\Controller
{
    protected $template;

    public function __construct(Template $template)
    {
        $this->template = $template;
    }

    public function action_index(Request $request)
    {
        return $this->template->render('app:home');
    }

    public function action_memcached(Request $request)
    {
        $cache = $this->components->cache();
        $cache->set('key', 'Hello Memcached!', 60);
        $value = $cache->get('key');
        return $this->response()->string($value);
    }

    public function action_redis(Request $request)
    {
        $redis = $this->components->redis();
        $redis->set('key', 'Hello Redis!');
        $value = $redis->get('key');
        return $this->response()->string($value);
    }

    public function action_mysql_add(Request $request)
    {
        $query = $this->components->database()->query();
        $query->insert('users')->data([
            'name' => 'ServBay',
            'email' => '[email protected]',
        ])->execute();
        return $this->response()->string('User added');
    }

    public function action_mysql(Request $request)
    {
        $query = $this->components->database()->query();
        $users = $query->select('*')->from('users')->execute()->fetchAll();
        return $this->response()->json($users);
    }
}

In the assets/templates/app/home.php file, add the following code:

<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Welcome to PHPixie</title>
</head>
<body>
    <h1>Welcome to PHPixie</h1>
    <p>The page you are looking at is being generated dynamically by PHPixie.</p>
</body>
</html>

Accessing the Site

Open your browser and visit the following URL:

• https://servbay-phpixie-test.local: You should see the page displaying Welcome to PHPixie.

NoSQL Database Examples

Memcached Example

1. Install Memcached Extension

   The Memcached extension is pre-installed in ServBay, so no extra installation is necessary.

2. Configure Memcached

   In the assets/config/cache.php file, configure the Memcached connection information:

   return [
       'default' => [
           'driver' => 'memcached',
           'servers' => [
               [
                   'host'   => '127.0.0.1',
                   'port'   => 11211,
                   'weight' => 100,
               ],
           ],
       ],
   ];

3. Use Memcached

   Use cache in the controller:

   public function action_memcached(Request $request)
   {
       $cache = $this->components->cache();
       $cache->set('key', 'Hello Memcached!', 60);
       $value = $cache->get('key');
       return $this->response()->string($value);
   }

Redis Example

1. Install Redis Extension

   The Redis extension is pre-installed in ServBay, so no extra installation is necessary.

2. Configure Redis

   In the assets/config/redis.php file, configure the Redis connection information:

   return [
       'default' => [
           'hostname' => '127.0.0.1',
           'port'     => 6379,
           'timeout'  => 0,
           'database' => 0,
       ],
   ];

3. Use Redis

   Use cache in the controller:

   public function action_redis(Request $request)
   {
       $redis = $this->components->redis();
       $redis->set('key', 'Hello Redis!');
       $value = $redis->get('key');
       return $this->response()->string($value);
   }

Relational Database Examples

Creating Database Structure and Migration Files

1. Create Migration File

   Use PHPixie's CLI tool to create a migration file:

   php pixie generate:migration create_users_table

2. Edit Migration File

   In the assets/migrations directory, locate the newly created migration file and edit it to define the database table structure:

   public function up()
   {
       $this->schema->create('users', function($table) {
           $table->increments('id');
           $table->string('name');
           $table->string('email')->unique();
           $table->timestamps();
       });
   }
   
   public function down()
   {
       $this->schema->drop('users');
   }

3. Run Migration

   Use PHPixie's CLI tool to run the migration and create the database table:

   php pixie migrate

MySQL Example

1. Configure MySQL

   In the assets/config/database.php file, configure the MySQL connection information:

   return [
       'default' => [
           'driver'    => 'pdo',
           'connection' => 'mysql:host=127.0.0.1;dbname=servbay_phpixie_app',
           'user'      => 'root',
           'password'  => 'password',
           'options'   => []
       ]
   ];

2. Insert User Data

   Use the controller to insert user data:

   public function action_mysql_add(Request $request)
   {
       $query = $this->components->database()->query();
       $query->insert('users')->data([
           'name' => 'ServBay',
           'email' => '[email protected]',
       ])->execute();
       return $this->response()->string('User added');
   }

3. Use MySQL

   Call the database in the controller:

   public function action_mysql(Request $request)
   {
       $query = $this->components->database()->query();
       $users = $query->select('*')->from('users')->execute()->fetchAll();
       return $this->response()->json($users);
   }

PostgreSQL Example

1. Configure PostgreSQL

   In the assets/config/database.php file, configure the PostgreSQL connection information:

   return [
       'default' => [
           'driver'    => 'pdo',
           'connection' => 'pgsql:host=127.0.0.1;dbname=servbay_phpixie_app',
           'user'      => 'root',
           'password'  => 'password',
           'options'   => []
       ]
   ];

2. Insert User Data

   Use the controller to insert user data:

   public function action_pgsql_add(Request $request)
   {
       $query = $this->components->database()->query();
       $query->insert('users')->data([
           'name' => 'ServBay',
           'email' => '[email protected]',
       ])->execute();
       return $this->response()->string('User added');
   }

3. Use PostgreSQL

   Call the database in the controller:

   public function action_pgsql(Request $request)
   {
       $query = $this->components->database()->query();
       $users = $query->select('*')->from('users')->execute()->fetchAll();
       return $this->response()->json($users);
   }

By following the above steps, you have successfully created and run a PHPixie project, managed and accessed the project using ServBay's functionalities, and connected to multiple databases and called data. We hope this article helps you get started with PHPixie and apply it to your projects.