feodorpranju/api-orm

There is no license information available for the latest version (v1.0.2) of this package.

Field and Model contracts and basic converters

v1.0.2 2023-11-20 20:12 UTC

Requires

• php: ^8.1
• brick/phonenumber: ^0.5.0
• egulias/email-validator: ^4.0
• guzzlehttp/guzzle: ^6.2.1|^7.0.1
• illuminate/collections: ^10.4
• illuminate/container: ^10.22
• illuminate/contracts: ^10.4
• illuminate/http: ^10.22
• illuminate/log: ^10.22
• illuminate/support: ^10.22
• nesbot/carbon: ^2.66
• psr/log: ^1.1.4 || ^2.0 || ^3.0

Requires (Dev)

• phpunit/phpunit: ^10.0
• symfony/var-dumper: ^6.2

Unknown License

• Fiodor Pranju

README

Add [e-mail]:feodorpranju/api-orm.git to your repository list in composer.json with type github. Install running composer require feodorpranju/api-orm.

Usage

• Model creation

  <?php
  
  use Feodorpranju\ApiOrm\Models\AbstractModel;
  use \Illuminate\Support\Collection;
  use \Feodorpranju\ApiOrm\Models\Fields\Settings as FieldSettings;
  use \Feodorpranju\ApiOrm\Enumerations\FieldType;
  
  class Task extends AbstractModel
  {
      /**
      * @inheritdoc 
      */
      public static function fields() : Collection
      {
          return collect([
              new FieldSettings('id', FieldType::Int, false, true),
              new FieldSettings('title', FieldType::String),
              new FieldSettings('name', FieldType::String),
              new FieldSettings('date', FieldType::Datetime),
          ]);
      }
  }

  Set required methods e.g. get(), fields(), find(), count()...

• Model initialization

  $task = Task::get(1);
  $task = Task::select()->first();
  $task = Task::where('id', 1)->first();
  $task = new Task(['id' => 1]);
  $task = Task::make(['id' => 1]);

• Model field usage

  $task = Task::make([
      'id' => 1,
      'title' => 'Lorem ipsum'
  ]);
  
  # Field get
  echo $task->id;
  echo $task['ID'];
  
  # All fields
  $fields = $task->only();
  $fields = $task->except();
  
  # Needed fields
  $fields = $task->only(['id']);
  $fields = $task->except(['id']);
  
  # Field set
  $task->id = 2;
  $task['id'] = 2;
  $task->put([
      'id' => 2,
      'name' => 'dolor'
  ]);

• Select models

  # Basic
  $tasks = Task::select()->all();
  $tasks = Task::select()->forPage(1, 10)->get();
  
  # With conditions
  $tasks = Task::select(['id', 'title'])->all();
  $tasks = Task::select()->where('id', 1)->all();
  $tasks = Task::where('id', '=', 1)->all();
  $tasks = Task::where('id', '!=', 1)->all();
  $tasks = Task::where('active')->all();
  $tasks = Task::where([
      'id' => 'Lorem',
      'title' => ['!=', 'ipsum'],
      ['name', 'dolor'],
      ['date', '<=', date('c')],
  ])->all();