Documentation

目次

前のトピックへ

< Class Phalcon\Mvc\Micro\LazyLoader

次のトピックへ

Abstract class Phalcon\Mvc\Model\Behavior >

このページ

Abstract class Phalcon\Mvc\Model

implements Phalcon\Mvc\ModelInterface, Phalcon\Mvc\Model\ResultInterface, Phalcon\DI\InjectionAwareInterface, Serializable

Phalcon\Mvc\Model connects business objects and database tables to create a persistable domain model where logic and data are presented in one wrapping. It‘s an implementation of the object-relational mapping (ORM). A model represents the information (data) of the application and the rules to manipulate that data. Models are primarily used for managing the rules of interaction with a corresponding database table. In most cases, each table in your database will correspond to one model in your application. The bulk of your application’s business logic will be concentrated in the models. Phalcon\Mvc\Model is the first ORM written in C-language for PHP, giving to developers high performance when interacting with databases while is also easy to use.

<?php

 $robot = new Robots();
 $robot->type = 'mechanical';
 $robot->name = 'Astro Boy';
 $robot->year = 1952;
 if ($robot->save() == false) {
  echo "Umh, We can store robots: ";
  foreach ($robot->getMessages() as $message) {
    echo $message;
  }
 } else {
  echo "Great, a new robot was saved successfully!";
 }

Constants

integer OP_NONE

integer OP_CREATE

integer OP_UPDATE

integer OP_DELETE

integer DIRTY_STATE_PERSISTENT

integer DIRTY_STATE_TRANSIENT

integer DIRTY_STATE_DETACHED

Methods

final public __construct ([Phalcon\DiInterface $dependencyInjector], [Phalcon\Mvc\Model\ManagerInterface $modelsManager])

Phalcon\Mvc\Model constructor

public setDI (Phalcon\DiInterface $dependencyInjector)

Sets the dependency injection container

public Phalcon\DiInterface getDI ()

Returns the dependency injection container

protected setEventsManager ()

Sets a custom events manager

protected Phalcon\Events\ManagerInterface getEventsManager ()

Returns the custom events manager

public Phalcon\Mvc\Model\MetaDataInterface getModelsMetaData ()

Returns the models meta-data service related to the entity instance

public Phalcon\Mvc\Model\ManagerInterface getModelsManager ()

Returns the models manager related to the entity instance

public Phalcon\Mvc\Model setTransaction (Phalcon\Mvc\Model\TransactionInterface $transaction)

Sets a transaction related to the Model instance

<?php

use Phalcon\Mvc\Model\Transaction\Manager as TxManager;
use Phalcon\Mvc\Model\Transaction\Failed as TxFailed;

try {

  $txManager = new TxManager();

  $transaction = $txManager->get();

  $robot = new Robots();
  $robot->setTransaction($transaction);
  $robot->name = 'WALL·E';
  $robot->created_at = date('Y-m-d');
  if ($robot->save() == false) {
    $transaction->rollback("Can't save robot");
  }

  $robotPart = new RobotParts();
  $robotPart->setTransaction($transaction);
  $robotPart->type = 'head';
  if ($robotPart->save() == false) {
    $transaction->rollback("Robot part cannot be saved");
  }

  $transaction->commit();

} catch (TxFailed $e) {
  echo 'Failed, reason: ', $e->getMessage();
}

protected Phalcon\Mvc\Model setSource ()

Sets table name which model should be mapped

public string getSource ()

Returns table name mapped in the model

protected Phalcon\Mvc\Model setSchema ()

Sets schema name where table mapped is located

public string getSchema ()

Returns schema name where table mapped is located

public Phalcon\Mvc\Model setConnectionService (string $connectionService)

Sets the DependencyInjection connection service name

public Phalcon\Mvc\Model setReadConnectionService (string $connectionService)

Sets the DependencyInjection connection service name used to read data

public Phalcon\Mvc\Model setWriteConnectionService (string $connectionService)

Sets the DependencyInjection connection service name used to write data

public string getReadConnectionService ()

Returns the DependencyInjection connection service name used to read data related the model

public string getWriteConnectionService ()

Returns the DependencyInjection connection service name used to write data related to the model

public Phalcon\Mvc\Model setDirtyState (int $dirtyState)

Sets the dirty state of the object using one of the DIRTY_STATE_* constants

public int getDirtyState ()

Returns one of the DIRTY_STATE_* constants telling if the record exists in the database or not

public Phalcon\Db\AdapterInterface getReadConnection ()

Gets the connection used to read data for the model

public Phalcon\Db\AdapterInterface getWriteConnection ()

Gets the connection used to write data to the model

public Phalcon\Mvc\Model assign (array $data, [array $columnMap])

Assigns values to a model from an array

<?php

$robot->assign(array(
  'type' => 'mechanical',
  'name' => 'Astro Boy',
  'year' => 1952
));

public static Phalcon\Mvc\Model cloneResultMap (Phalcon\Mvc\Model $base, array $data, array $columnMap, [int $dirtyState], [boolean $keepSnapshots])

Assigns values to a model from an array returning a new model.

<?php

$robot = \Phalcon\Mvc\Model::cloneResultMap(new Robots(), array(
  'type' => 'mechanical',
  'name' => 'Astro Boy',
  'year' => 1952
));

public static mixed cloneResultMapHydrate (array $data, array $columnMap, int $hydrationMode)

Returns an hydrated result based on the data and the column map

public static Phalcon\Mvc\Model cloneResult (Phalcon\Mvc\Model $base, array $data, [int $dirtyState])

Assigns values to a model from an array returning a new model

<?php

$robot = Phalcon\Mvc\Model::cloneResult(new Robots(), array(
  'type' => 'mechanical',
  'name' => 'Astro Boy',
  'year' => 1952
));

public static Phalcon\Mvc\Model\ResultsetInterface find ([array $parameters])

Allows to query a set of records that match the specified conditions

<?php

 //How many robots are there?
 $robots = Robots::find();
 echo "There are ", count($robots), "\n";

 //How many mechanical robots are there?
 $robots = Robots::find("type='mechanical'");
 echo "There are ", count($robots), "\n";

 //Get and print virtual robots ordered by name
 $robots = Robots::find(array("type='virtual'", "order" => "name"));
 foreach ($robots as $robot) {
   echo $robot->name, "\n";
 }

 //Get first 100 virtual robots ordered by name
 $robots = Robots::find(array("type='virtual'", "order" => "name", "limit" => 100));
 foreach ($robots as $robot) {
   echo $robot->name, "\n";
 }

public static Phalcon\Mvc\Model findFirst ([array $parameters])

Allows to query the first record that match the specified conditions

<?php

 //What's the first robot in robots table?
 $robot = Robots::findFirst();
 echo "The robot name is ", $robot->name;

 //What's the first mechanical robot in robots table?
 $robot = Robots::findFirst("type='mechanical'");
 echo "The first mechanical robot name is ", $robot->name;

 //Get first virtual robot ordered by name
 $robot = Robots::findFirst(array("type='virtual'", "order" => "name"));
 echo "The first virtual robot name is ", $robot->name;

public static Phalcon\Mvc\Model\Criteria query ([Phalcon\DiInterface $dependencyInjector])

Create a criteria for a specific model

protected boolean _exists ()

Checks if the current record already exists or not

protected static Phalcon\Mvc\Model\ResultsetInterface _groupResult ()

Generate a PHQL SELECT statement for an aggregate

public static int count ([array $parameters])

Allows to count how many records match the specified conditions

<?php

 //How many robots are there?
 $number = Robots::count();
 echo "There are ", $number, "\n";

 //How many mechanical robots are there?
 $number = Robots::count("type='mechanical'");
 echo "There are ", $number, " mechanical robots\n";

public static double sum ([array $parameters])

Allows to calculate a summatory on a column that match the specified conditions

<?php

 //How much are all robots?
 $sum = Robots::sum(array('column' => 'price'));
 echo "The total price of robots is ", $sum, "\n";

 //How much are mechanical robots?
 $sum = Robots::sum(array("type='mechanical'", 'column' => 'price'));
 echo "The total price of mechanical robots is  ", $sum, "\n";

public static mixed maximum ([array $parameters])

Allows to get the maximum value of a column that match the specified conditions

<?php

 //What is the maximum robot id?
 $id = Robots::maximum(array('column' => 'id'));
 echo "The maximum robot id is: ", $id, "\n";

 //What is the maximum id of mechanical robots?
 $sum = Robots::maximum(array("type='mechanical'", 'column' => 'id'));
 echo "The maximum robot id of mechanical robots is ", $id, "\n";

public static mixed minimum ([array $parameters])

Allows to get the minimum value of a column that match the specified conditions

<?php

 //What is the minimum robot id?
 $id = Robots::minimum(array('column' => 'id'));
 echo "The minimum robot id is: ", $id;

 //What is the minimum id of mechanical robots?
 $sum = Robots::minimum(array("type='mechanical'", 'column' => 'id'));
 echo "The minimum robot id of mechanical robots is ", $id;

public static double average ([array $parameters])

Allows to calculate the average value on a column matching the specified conditions

<?php

 //What's the average price of robots?
 $average = Robots::average(array('column' => 'price'));
 echo "The average price is ", $average, "\n";

 //What's the average price of mechanical robots?
 $average = Robots::average(array("type='mechanical'", 'column' => 'price'));
 echo "The average price of mechanical robots is ", $average, "\n";

public boolean fireEvent (string $eventName)

Fires an event, implicitly calls behaviors and listeners in the events manager are notified

public boolean fireEventCancel (string $eventName)

Fires an event, implicitly calls behaviors and listeners in the events manager are notified This method stops if one of the callbacks/listeners returns boolean false

protected boolean _cancelOperation ()

Cancel the current operation

public Phalcon\Mvc\Model appendMessage (Phalcon\Mvc\Model\MessageInterface $message)

Appends a customized message on the validation process

<?php

 use \Phalcon\Mvc\Model\Message as Message;

 class Robots extends Phalcon\Mvc\Model
 {

   public function beforeSave()
   {
     if ($this->name == 'Peter') {
        $message = new Message("Sorry, but a robot cannot be named Peter");
        $this->appendMessage($message);
     }
   }
 }

protected Phalcon\Mvc\Model validate ()

Executes validators on every validation call

<?php

use Phalcon\Mvc\Model\Validator\ExclusionIn as ExclusionIn;

class Subscriptors extends Phalcon\Mvc\Model
{

public function validation()
  {
            $this->validate(new ExclusionIn(array(
            'field' => 'status',
            'domain' => array('A', 'I')
    )));
    if ($this->validationHasFailed() == true) {
            return false;
    }
}

}

public boolean validationHasFailed ()

Check whether validation process has generated any messages

<?php

use Phalcon\Mvc\Model\Validator\ExclusionIn as ExclusionIn;

class Subscriptors extends Phalcon\Mvc\Model
{

public function validation()
  {
            $this->validate(new ExclusionIn(array(
            'field' => 'status',
            'domain' => array('A', 'I')
    )));
    if ($this->validationHasFailed() == true) {
            return false;
    }
}

}

public Phalcon\Mvc\Model\MessageInterface [] getMessages ()

Returns all the validation messages

<?php

$robot = new Robots();
$robot->type = 'mechanical';
$robot->name = 'Astro Boy';
$robot->year = 1952;
if ($robot->save() == false) {
    echo "Umh, We can't store robots right now ";
    foreach ($robot->getMessages() as $message) {
            echo $message;
    }
} else {
    echo "Great, a new robot was saved successfully!";
}

protected boolean _checkForeignKeysRestrict ()

Reads “belongs to” relations and check the virtual foreign keys when inserting or updating records to verify that inserted/updated values are present in the related entity

protected boolean _checkForeignKeysReverseRestrict ()

Reads both “hasMany” and “hasOne” relations and checks the virtual foreign keys (restrict) when deleting records

protected boolean _checkForeignKeysReverseCascade ()

Reads both “hasMany” and “hasOne” relations and checks the virtual foreign keys (cascade) when deleting records

protected boolean _preSave ()

Executes internal hooks before save a record

protected boolean _postSave ()

Executes internal events after save a record

protected boolean _doLowInsert ()

Sends a pre-build INSERT SQL statement to the relational database system

protected boolean _doLowUpdate ()

Sends a pre-build UPDATE SQL statement to the relational database system

protected boolean _preSaveRelatedRecords ()

Saves related records that must be stored prior to save the master record

protected boolean _postSaveRelatedRecords ()

Save the related records assigned in the has-one/has-many relations

public boolean save ([array $data], [array $whiteList])

Inserts or updates a model instance. Returning true on success or false otherwise.

<?php

//Creating a new robot
$robot = new Robots();
$robot->type = 'mechanical';
$robot->name = 'Astro Boy';
$robot->year = 1952;
$robot->save();

//Updating a robot name
$robot = Robots::findFirst("id=100");
$robot->name = "Biomass";
$robot->save();

public boolean create ([array $data], [array $whiteList])

Inserts a model instance. If the instance already exists in the persistance it will throw an exception Returning true on success or false otherwise.

<?php

//Creating a new robot
$robot = new Robots();
$robot->type = 'mechanical';
$robot->name = 'Astro Boy';
$robot->year = 1952;
$robot->create();

  //Passing an array to create
  $robot = new Robots();
  $robot->create(array(
      'type' => 'mechanical',
      'name' => 'Astroy Boy',
      'year' => 1952
  ));

public boolean update ([array $data], [array $whiteList])

Updates a model instance. If the instance doesn’t exist in the persistance it will throw an exception Returning true on success or false otherwise.

<?php

//Updating a robot name
$robot = Robots::findFirst("id=100");
$robot->name = "Biomass";
$robot->update();

public boolean delete ()

Deletes a model instance. Returning true on success or false otherwise.

<?php

$robot = Robots::findFirst("id=100");
$robot->delete();

foreach (Robots::find("type = 'mechanical'") as $robot) {
   $robot->delete();
}

public int getOperationMade ()

Returns the type of the latest operation performed by the ORM Returns one of the OP_* class constants

public refresh ()

Refreshes the model attributes re-querying the record from the database

public skipOperation (boolean $skip)

Skips the current operation forcing a success state

public mixed readAttribute (string $attribute)

Reads an attribute value by its name

<?php

 echo $robot->readAttribute('name');

public writeAttribute (string $attribute, mixed $value)

Writes an attribute value by its name

<?php

    $robot->writeAttribute('name', 'Rosey');

protected skipAttributes ()

Sets a list of attributes that must be skipped from the generated INSERT/UPDATE statement

<?php

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
       $this->skipAttributes(array('price'));
   }

}

protected skipAttributesOnCreate ()

Sets a list of attributes that must be skipped from the generated INSERT statement

<?php

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
       $this->skipAttributesOnCreate(array('created_at'));
   }

}

protected skipAttributesOnUpdate ()

Sets a list of attributes that must be skipped from the generated UPDATE statement

<?php

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
       $this->skipAttributesOnUpdate(array('modified_in'));
   }

}

public Phalcon\Mvc\Model\Relation hasOne ()

Setup a 1-1 relation between two models

<?php

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
       $this->hasOne('id', 'RobotsDescription', 'robots_id');
   }

}

public Phalcon\Mvc\Model\Relation belongsTo ()

Setup a relation reverse 1-1 between two models

<?php

class RobotsParts extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
       $this->belongsTo('robots_id', 'Robots', 'id');
   }

}

public Phalcon\Mvc\Model\Relation hasMany ()

Setup a relation 1-n between two models

<?php

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
       $this->hasMany('id', 'RobotsParts', 'robots_id');
   }

}

public Phalcon\Mvc\Model\Relation hasManyToMany ()

Setup a relation n-n between two models through an intermediate relation

<?php

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
       //Setup a many-to-many relation to Parts through RobotsParts
       $this->hasManyToMany(
            'id',
            'RobotsParts',
            'robots_id',
            'parts_id',
            'Parts',
            'id'
    );
   }

}

public addBehavior ()

Setups a behavior in a model

<?php

use Phalcon\Mvc\Model\Behavior\Timestampable;

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
    $this->addBehavior(new Timestampable(array(
            'onCreate' => array(
                    'field' => 'created_at',
                    'format' => 'Y-m-d'
            )
    )));
   }

}

protected keepSnapshots ()

Sets if the model must keep the original record snapshot in memory

<?php

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
    $this->keepSnapshots(true);
   }

}

public setSnapshotData (array $data, [array $columnMap])

Sets the record’s snapshot data. This method is used internally to set snapshot data when the model was set up to keep snapshot data

public boolean hasSnapshotData ()

Checks if the object has internal snapshot data

public array getSnapshotData ()

Returns the internal snapshot data

public hasChanged ([boolean $fieldName])

Check if a specific attribute has changed This only works if the model is keeping data snapshots

public array getChangedFields ()

Returns a list of changed values

protected useDynamicUpdate ()

Sets if a model must use dynamic update instead of the all-field update

<?php

class Robots extends \Phalcon\Mvc\Model
{

   public function initialize()
   {
    $this->useDynamicUpdate(true);
   }

}

public Phalcon\Mvc\Model\ResultsetInterface getRelated (string $alias, [array $arguments])

Returns related records based on defined relations

protected mixed _getRelatedRecords ()

Returns related records defined relations depending on the method name

public mixed __call (string $method, [array $arguments])

Handles method calls when a method is not implemented

public static mixed __callStatic (string $method, [array $arguments])

Handles method calls when a static method is not implemented

public __set (string $property, mixed $value)

Magic method to assign values to the the model

public Phalcon\Mvc\Model\Resultset __get (string $property)

Magic method to get related records using the relation alias as a property

public __isset (string $property)

Magic method to check if a property is a valid relation

public string serialize ()

Serializes the object ignoring connections, services, related objects or static properties

public unserialize (string $data)

Unserializes the object from a serialized string

public array dump ()

Returns a simple representation of the object that can be used with var_dump

<?php

 var_dump($robot->dump());

public array toArray ()

Returns the instance as an array representation

<?php

 print_r($robot->toArray());

public static setup (array $options)

Enables/disables options in the ORM Available options: events — Enables/Disables globally the internal events virtualForeignKeys — Enables/Disables virtual foreign keys columnRenaming — Enables/Disables column renaming notNullValidations — Enables/Disables automatic not null validation exceptionOnFailedSave — Enables/Disables throws an exception if the saving process fails phqlLiterals — Enables/Disables literals in PHQL this improves the security of applications