Skip to content

Home

Jump to bottom
Rumen Damyanov edited this page Sep 22, 2025 · 3 revisions

PHP-SEO Package Documentation

Welcome to the comprehensive documentation for the PHP-SEO package - a powerful, framework-agnostic SEO optimization library for modern PHP applications.

🎯 Overview

The PHP-SEO package provides automated SEO optimization capabilities with AI-powered content analysis and generation. It supports manual configuration, AI integration, and comes with native support for Laravel and Symfony frameworks.

Key Features

  • ✅ Framework Agnostic: Works with any PHP 8.2+ application
  • ✅ AI-Powered: Multiple AI provider support (OpenAI, Anthropic, Google, Ollama)
  • ✅ Manual Fallback: Pattern-based generation when AI is unavailable
  • ✅ Laravel Integration: Native service provider, facade, and middleware
  • ✅ Symfony Integration: Complete bundle with Twig extensions and event listeners
  • ✅ Content Analysis: Automatic extraction of headings, images, links, and keywords
  • ✅ Meta Tag Generation: Complete Open Graph, Twitter Cards, and standard meta tags
  • ✅ Structured Data: Schema.org markup support
  • ✅ Caching: Built-in caching for improved performance
  • ✅ Testing: Comprehensive test coverage with Pest framework

📦 Installation

Install the package via Composer:

composer require rumenx/php-seo

Requirements

  • PHP 8.2 or higher
  • Composer for dependency management
  • Optional: Laravel 10+ or Symfony 6+ for framework integration

🚀 Quick Start

Here's a simple example to get you started:

use Rumenx\PhpSeo\SeoManager;
use Rumenx\PhpSeo\Config\SeoConfig;

// Create configuration
$config = new SeoConfig([
    'ai' => ['enabled' => false], // Start with manual mode
    'title' => ['max_length' => 60],
    'description' => ['max_length' => 160],
]);

// Initialize SEO manager
$seoManager = new SeoManager($config);

// Analyze your content
$htmlContent = '<h1>My Page</h1><p>Page content...</p>';
$analysis = $seoManager->analyze($htmlContent, [
    'title' => 'My Page Title',
    'url' => 'https://example.com/my-page',
]);

// Generate SEO elements
$title = $seoManager->generateTitle($analysis);
$description = $seoManager->generateDescription($analysis);
$metaTags = $seoManager->generateMetaTags($analysis);

// Render HTML meta tags
$htmlOutput = $seoManager->renderMetaTags($metaTags);
echo $htmlOutput;

📚 Documentation Structure

This documentation is organized into the following sections:

Core Documentation

Framework Integration

Advanced Topics

Examples and Tutorials

🎨 Package Architecture

The PHP-SEO package follows a modular architecture:

php-seo/
├── src/
│   ├── SeoManager.php           # Main orchestration class
│   ├── Config/
│   │   └── SeoConfig.php        # Configuration management
│   ├── Analyzers/
│   │   └── ContentAnalyzer.php  # Content analysis
│   ├── Generators/
│   │   ├── TitleGenerator.php   # Title generation
│   │   ├── DescriptionGenerator.php # Description generation
│   │   └── MetaTagGenerator.php # Meta tag generation
│   ├── Providers/
│   │   └── OpenAiProvider.php   # AI provider implementations
│   ├── Contracts/               # Interfaces
│   └── Integrations/            # Framework integrations
│       ├── Laravel/
│       └── Symfony/
├── config/
│   └── seo.php                  # Default configuration
├── examples/                    # Code examples
└── tests/                       # Test suite

🔧 Core Components

SeoManager

The main class that orchestrates all SEO operations. It coordinates content analysis, generation, and rendering.

SeoConfig

Comprehensive configuration system supporting environment variables, nested settings, and framework-specific options.

ContentAnalyzer

Analyzes HTML content to extract:

  • Headings (H1-H6)
  • Images with alt text and metadata
  • Internal and external links
  • Keywords and key phrases
  • Content metrics (word count, language, etc.)

Generators

Specialized classes for generating:

  • TitleGenerator: SEO-optimized page titles with templates
  • DescriptionGenerator: Meta descriptions from content analysis
  • MetaTagGenerator: Complete meta tag sets including Open Graph and Twitter Cards

AI Providers

Pluggable AI integrations:

  • OpenAI (GPT models)
  • Anthropic (Claude models)
  • Google (Gemini models)
  • Ollama (Local models)

🌟 Why Choose PHP-SEO?

Enterprise-Ready

  • Production-tested architecture
  • Comprehensive error handling
  • Built-in caching and performance optimization
  • Extensive test coverage (100% goal)

Developer-Friendly

  • Modern PHP 8.2+ with strict typing
  • PSR-4 autoloading and PSR-12 coding standards
  • Comprehensive documentation and examples
  • IDE-friendly with full type hints

Flexible Integration

  • Framework-agnostic core
  • Native Laravel and Symfony support
  • Pluggable AI providers
  • Configurable fallback strategies

AI-Powered with Fallbacks

  • Multiple AI provider support
  • Automatic fallback to manual generation
  • Cost-effective AI usage with caching
  • Rate limiting and error handling

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details on:

  • Code standards and guidelines
  • Testing requirements
  • Pull request process
  • Issue reporting

📄 License

This package is open-sourced software licensed under the MIT License.

🆘 Support

  • Documentation: Complete guides and examples in this wiki
  • Issues: Report bugs and feature requests on GitHub Issues
  • Discussions: Join community discussions on GitHub Discussions

🚀 Next Steps

Ready to get started? Here are some suggested next steps:

  1. Configuration - Set up your configuration
  2. Laravel Examples - Integrate with your framework
  3. AI Integration - Configure AI providers
  4. Basic Examples - Try some examples

Happy optimizing! 🎯

Clone this wiki locally