Chatea Common Laravel Package

Getting Started

Minimal Steps

1. Installation Add the package via Composer (if still functional):

   composer require antwebes/chatea-common
   

   Note: Due to the last release being in 2015, verify compatibility with your Laravel version (likely pre-5.x).

2. Locate Core Classes Browse the package’s src/ directory (or vendor/antwebes/chatea-common/src/) for:

   • Base models (e.g., BaseModel.php)
   • Utility interfaces (e.g., SerializableInterface.php)
   • Common traits (e.g., ArrayableTrait.php)

3. First Use Case Extend a base model in your Laravel app:

   use Antwebes\Common\BaseModel;
   
   class User extends BaseModel
   {
       // Inherits common methods like `toArray()`, `serialize()`
   }
   

Implementation Patterns

Workflows

1. Model Standardization

   • Use BaseModel to enforce consistent behavior (e.g., toArray(), serialize()) across all Eloquent models.
   • Example:

     class Post extends BaseModel
     {
         protected $fillable = ['title', 'content'];
         // Automatically gains `toArray()` via trait.
     }
     

2. Interface Adoption

   • Implement SerializableInterface for custom serialization logic:

     class ApiResponse implements SerializableInterface
     {
         public function serialize(): string
         {
             return json_encode($this->toArray());
         }
     }
     

3. Trait Composition

   • Combine traits (e.g., ArrayableTrait + JsonSerializableTrait) in custom classes:

     use Antwebes\Common\Traits\{ArrayableTrait, JsonSerializableTrait};
     
     class ExportableCollection
     {
         use ArrayableTrait, JsonSerializableTrait;
     }
     

Integration Tips

• Laravel Service Providers Bind interfaces to implementations in AppServiceProvider:

  $this->app->bind(
      Antwebes\Common\Interfaces\LoggerInterface::class,
      App\Services\CustomLogger::class
  );
  

• Configuration Check for legacy config files (e.g., config/common.php) and adapt to Laravel’s binding system.

Gotchas and Tips

Pitfalls

1. Deprecated Laravel Features

   • The package likely assumes Laravel 4.x. Avoid:
     • Model::boot() static methods (use booted() in Laravel 5+).
     • Global helpers (e.g., str_limit(); use Str::limit()).

2. Namespace Collisions

   • The package uses Antwebes\Common; ensure no conflicts with your app’s App\Common or similar.

3. Static Methods

   • Avoid static calls to BaseModel (e.g., BaseModel::find()). Use dependency injection instead.

Debugging

• Trait Overrides If methods like toArray() behave unexpectedly, check for:

  • Method conflicts in child classes.
  • Laravel’s Arrayable interface taking precedence.

• Serialization Issues Implement SerializableInterface explicitly if serialize() fails:

  public function serialize(): string
  {
      return json_encode($this->attributesToArray());
  }
  

Extension Points

1. Custom Traits Extend existing traits (e.g., ArrayableTrait) by publishing them to your app:

   php artisan vendor:publish --provider="Antwebes\Common\CommonServiceProvider"
   

   Note: Verify if the package supports publishing.

2. Interface Implementations Override default implementations (e.g., SerializableInterface) in child classes for project-specific logic.

3. Legacy Compatibility For Laravel 5/6/7/8/9, wrap static calls in a facade or service container binding:

   facade('common', Antwebes\Common\Facades\CommonFacade::class);