Entity
Entity is class to access database. Entity is derived from MagicObject. Some annotations required to activated all entity features.
+Constructor
+Parameters:
+-
+
- array|stdClass|object $data +
Initial data
+-
+
- PicoDatabase $database +
Database connection
<?php
namespace MusicProductionManager\Data\Entity;
@@ -1489,6 +1499,9 @@ Property Parameters
2. GenerationType.IDENTITY
Autoincrement using database feature
+3. TABLE Not implemented yet
+4. SEQUENCE Not implemented yet
+5. AUTO Not implemented yet
MagicObject will not update time_create, admin_create, and ip_create because updatable=false. So, even if the application wants to update this value, this column will be ignored when performing an update query to the database.
generator is generator of the value.
@NotNull
@@ -4578,6 +4591,849 @@ Filter Delete
$album = new Album(null, $database);
$album->where($specfification)->delete();
Subquery
+For large data with a very large number of records, using joins, whether inner joins, outer joins, left joins or right joins, will require a lot of resources, which will reduce application and database performance. MagicObject version 1.10 introduces searches using subqueries instead of joins so that the data search process becomes faster.
+Using subqueries is not without its drawbacks. The unavoidable disadvantages of subqueries are as follows:
+-
+
- just take one column from the reference table +
- Cannot use columns in the reference table either for filter (where) or for sorting (order by). +
Users must be aware of these two shortcomings before deciding to use a subquery.
+Example:
+/**
+ * @Entity
+ * @JSON(property-naming-strategy=SNAKE_CASE, prettify=true)
+ * @Table(name="album")
+ */
+class EntityAlbum extends MagicObject
+{
+ /**
+ * Album ID
+ *
+ * @Id
+ * @GeneratedValue(strategy=GenerationType.UUID)
+ * @NotNull
+ * @Column(name="album_id", type="varchar(50)", length=50, nullable=false)
+ * @Label(content="Album ID")
+ * @var string
+ */
+ protected $albumId;
+
+ /**
+ * Name
+ *
+ * @Column(name="name", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="Name")
+ * @var string
+ */
+ protected $name;
+
+ /**
+ * Title
+ *
+ * @Column(name="title", type="text", nullable=true)
+ * @Label(content="Title")
+ * @var string
+ */
+ protected $title;
+
+ /**
+ * Description
+ *
+ * @Column(name="description", type="longtext", nullable=true)
+ * @Label(content="Description")
+ * @var string
+ */
+ protected $description;
+
+ /**
+ * Producer ID
+ *
+ * @Column(name="producer_id", type="varchar(40)", length=40, nullable=true)
+ * @Label(content="Producer ID")
+ * @var string
+ */
+ protected $producerId;
+
+ /**
+ * Producer
+ *
+ * @JoinColumn(name="producer_id")
+ * @Label(content="Producer")
+ * @var Producer
+ */
+ protected $producer;
+
+ /**
+ * Release Date
+ *
+ * @Column(name="release_date", type="date", nullable=true)
+ * @Label(content="Release Date")
+ * @var string
+ */
+ protected $releaseDate;
+
+ /**
+ * Number Of Song
+ *
+ * @Column(name="number_of_song", type="int(11)", length=11, nullable=true)
+ * @Label(content="Number Of Song")
+ * @var integer
+ */
+ protected $numberOfSong;
+
+ /**
+ * Duration
+ *
+ * @Column(name="duration", type="float", nullable=true)
+ * @Label(content="Duration")
+ * @var double
+ */
+ protected $duration;
+
+ /**
+ * Image Path
+ *
+ * @Column(name="image_path", type="text", nullable=true)
+ * @Label(content="Image Path")
+ * @var string
+ */
+ protected $imagePath;
+
+ /**
+ * Sort Order
+ *
+ * @Column(name="sort_order", type="int(11)", length=11, nullable=true)
+ * @Label(content="Sort Order")
+ * @var integer
+ */
+ protected $sortOrder;
+
+ /**
+ * Time Create
+ *
+ * @Column(name="time_create", type="timestamp", length=19, nullable=true, updatable=false)
+ * @Label(content="Time Create")
+ * @var string
+ */
+ protected $timeCreate;
+
+ /**
+ * Time Edit
+ *
+ * @Column(name="time_edit", type="timestamp", length=19, nullable=true)
+ * @Label(content="Time Edit")
+ * @var string
+ */
+ protected $timeEdit;
+
+ /**
+ * Admin Create
+ *
+ * @Column(name="admin_create", type="varchar(40)", length=40, nullable=true, updatable=false)
+ * @Label(content="Admin Create")
+ * @var string
+ */
+ protected $adminCreate;
+
+ /**
+ * Admin Edit
+ *
+ * @Column(name="admin_edit", type="varchar(40)", length=40, nullable=true)
+ * @Label(content="Admin Edit")
+ * @var string
+ */
+ protected $adminEdit;
+
+ /**
+ * IP Create
+ *
+ * @Column(name="ip_create", type="varchar(50)", length=50, nullable=true, updatable=false)
+ * @Label(content="IP Create")
+ * @var string
+ */
+ protected $ipCreate;
+
+ /**
+ * IP Edit
+ *
+ * @Column(name="ip_edit", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="IP Edit")
+ * @var string
+ */
+ protected $ipEdit;
+
+ /**
+ * Active
+ *
+ * @Column(name="active", type="tinyint(1)", length=1, default_value="1", nullable=true)
+ * @DefaultColumn(value="1")
+ * @Label(content="Active")
+ * @var boolean
+ */
+ protected $active;
+
+ /**
+ * As Draft
+ *
+ * @Column(name="as_draft", type="tinyint(1)", length=1, default_value="1", nullable=true)
+ * @DefaultColumn(value="1")
+ * @var boolean
+ */
+ protected $asDraft;
+
+}
+
+/**
+ * @Entity
+ * @JSON(property-naming-strategy=SNAKE_CASE, prettify=true)
+ * @Table(name="producer")
+ */
+class Producer extends MagicObject
+{
+ /**
+ * Producer ID
+ *
+ * @Id
+ * @GeneratedValue(strategy=GenerationType.UUID)
+ * @NotNull
+ * @Column(name="producer_id", type="varchar(40)", length=40, nullable=false)
+ * @Label(content="Producer ID")
+ * @var string
+ */
+ protected $producerId;
+
+ /**
+ * Name
+ *
+ * @Column(name="name", type="varchar(100)", length=100, nullable=true)
+ * @Label(content="Name")
+ * @var string
+ */
+ protected $name;
+
+ /**
+ * Gender
+ *
+ * @Column(name="gender", type="varchar(2)", length=2, nullable=true)
+ * @Label(content="Gender")
+ * @var string
+ */
+ protected $gender;
+
+ /**
+ * Birth Day
+ *
+ * @Column(name="birth_day", type="date", nullable=true)
+ * @Label(content="Birth Day")
+ * @var string
+ */
+ protected $birthDay;
+
+ /**
+ * Phone
+ *
+ * @Column(name="phone", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="Phone")
+ * @var string
+ */
+ protected $phone;
+
+ /**
+ * Phone2
+ *
+ * @Column(name="phone2", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="Phone2")
+ * @var string
+ */
+ protected $phone2;
+
+ /**
+ * Phone3
+ *
+ * @Column(name="phone3", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="Phone3")
+ * @var string
+ */
+ protected $phone3;
+
+ /**
+ * Email
+ *
+ * @Column(name="email", type="varchar(100)", length=100, nullable=true)
+ * @Label(content="Email")
+ * @var string
+ */
+ protected $email;
+
+ /**
+ * Email2
+ *
+ * @Column(name="email2", type="varchar(100)", length=100, nullable=true)
+ * @Label(content="Email2")
+ * @var string
+ */
+ protected $email2;
+
+ /**
+ * Email3
+ *
+ * @Column(name="email3", type="varchar(100)", length=100, nullable=true)
+ * @Label(content="Email3")
+ * @var string
+ */
+ protected $email3;
+
+ /**
+ * Website
+ *
+ * @Column(name="website", type="text", nullable=true)
+ * @Label(content="Website")
+ * @var string
+ */
+ protected $website;
+
+ /**
+ * Address
+ *
+ * @Column(name="address", type="text", nullable=true)
+ * @Label(content="Address")
+ * @var string
+ */
+ protected $address;
+
+ /**
+ * Picture
+ *
+ * @Column(name="picture", type="tinyint(1)", length=1, nullable=true)
+ * @var boolean
+ */
+ protected $picture;
+
+ /**
+ * Image Path
+ *
+ * @Column(name="image_path", type="text", nullable=true)
+ * @Label(content="Image Path")
+ * @var string
+ */
+ protected $imagePath;
+
+ /**
+ * Image Update
+ *
+ * @Column(name="image_update", type="timestamp", length=19, nullable=true)
+ * @Label(content="Image Update")
+ * @var string
+ */
+ protected $imageUpdate;
+
+ /**
+ * Time Create
+ *
+ * @Column(name="time_create", type="timestamp", length=19, nullable=true, updatable=false)
+ * @Label(content="Time Create")
+ * @var string
+ */
+ protected $timeCreate;
+
+ /**
+ * Time Edit
+ *
+ * @Column(name="time_edit", type="timestamp", length=19, nullable=true)
+ * @Label(content="Time Edit")
+ * @var string
+ */
+ protected $timeEdit;
+
+ /**
+ * Admin Create
+ *
+ * @Column(name="admin_create", type="varchar(40)", length=40, nullable=true, updatable=false)
+ * @Label(content="Admin Create")
+ * @var string
+ */
+ protected $adminCreate;
+
+ /**
+ * Admin Edit
+ *
+ * @Column(name="admin_edit", type="varchar(40)", length=40, nullable=true)
+ * @Label(content="Admin Edit")
+ * @var string
+ */
+ protected $adminEdit;
+
+ /**
+ * IP Create
+ *
+ * @Column(name="ip_create", type="varchar(50)", length=50, nullable=true, updatable=false)
+ * @Label(content="IP Create")
+ * @var string
+ */
+ protected $ipCreate;
+
+ /**
+ * IP Edit
+ *
+ * @Column(name="ip_edit", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="IP Edit")
+ * @var string
+ */
+ protected $ipEdit;
+
+ /**
+ * Active
+ *
+ * @Column(name="active", type="tinyint(1)", length=1, default_value="1", nullable=true)
+ * @DefaultColumn(value="1")
+ * @Label(content="Active")
+ * @var boolean
+ */
+ protected $active;
+
+}
+
+$album = new EntityAlbum(null, $database);
+
+$subqueryMap = array(
+ 'producer'=>array(
+ 'entityName'=>'Producer',
+ 'tableName'=>'producer',
+ 'primaryKey'=>'producer_id',
+ 'columnName'=>'producer_id',
+ 'objectName'=>'producer',
+ 'propertyName'=>'name'
+ )
+);
+
+$result = $album->findAll(null, null, null, true, $subqueryMap);
+
+foreach($result->getResult() as $row)
+{
+ echo $row;
+}Find All with Option
+-
+
- MagicObject::FIND_OPTION_NO_COUNT_DATA +
- MagicObject::FIND_OPTION_NO_FETCH_DATA +
If the MagicObject::FIND_OPTION_NO_COUNT_DATA option is provided, the MagicObject will not count data even if a PicoPageable is provided. This will reduce data processing time but the user does not know how much data actually is. This option can be selected when dealing with very large data.
If the MagicObject::FIND_OPTION_NO_FETCH_DATA option is given, MagicObject will not directly fetch data and store it in the object. Users must retrieve data one by one using the fetch method. This option can be selected when handling very large data so that it does not consume much memory.
Example:
+/**
+ * @Entity
+ * @JSON(property-naming-strategy=SNAKE_CASE, prettify=true)
+ * @Table(name="album")
+ */
+class EntityAlbum extends MagicObject
+{
+ /**
+ * Album ID
+ *
+ * @Id
+ * @GeneratedValue(strategy=GenerationType.UUID)
+ * @NotNull
+ * @Column(name="album_id", type="varchar(50)", length=50, nullable=false)
+ * @Label(content="Album ID")
+ * @var string
+ */
+ protected $albumId;
+
+ /**
+ * Name
+ *
+ * @Column(name="name", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="Name")
+ * @var string
+ */
+ protected $name;
+
+ /**
+ * Title
+ *
+ * @Column(name="title", type="text", nullable=true)
+ * @Label(content="Title")
+ * @var string
+ */
+ protected $title;
+
+ /**
+ * Description
+ *
+ * @Column(name="description", type="longtext", nullable=true)
+ * @Label(content="Description")
+ * @var string
+ */
+ protected $description;
+
+ /**
+ * Producer ID
+ *
+ * @Column(name="producer_id", type="varchar(40)", length=40, nullable=true)
+ * @Label(content="Producer ID")
+ * @var string
+ */
+ protected $producerId;
+
+ /**
+ * Producer
+ *
+ * @JoinColumn(name="producer_id")
+ * @Label(content="Producer")
+ * @var Producer
+ */
+ protected $producer;
+
+ /**
+ * Release Date
+ *
+ * @Column(name="release_date", type="date", nullable=true)
+ * @Label(content="Release Date")
+ * @var string
+ */
+ protected $releaseDate;
+
+ /**
+ * Number Of Song
+ *
+ * @Column(name="number_of_song", type="int(11)", length=11, nullable=true)
+ * @Label(content="Number Of Song")
+ * @var integer
+ */
+ protected $numberOfSong;
+
+ /**
+ * Duration
+ *
+ * @Column(name="duration", type="float", nullable=true)
+ * @Label(content="Duration")
+ * @var double
+ */
+ protected $duration;
+
+ /**
+ * Image Path
+ *
+ * @Column(name="image_path", type="text", nullable=true)
+ * @Label(content="Image Path")
+ * @var string
+ */
+ protected $imagePath;
+
+ /**
+ * Sort Order
+ *
+ * @Column(name="sort_order", type="int(11)", length=11, nullable=true)
+ * @Label(content="Sort Order")
+ * @var integer
+ */
+ protected $sortOrder;
+
+ /**
+ * Time Create
+ *
+ * @Column(name="time_create", type="timestamp", length=19, nullable=true, updatable=false)
+ * @Label(content="Time Create")
+ * @var string
+ */
+ protected $timeCreate;
+
+ /**
+ * Time Edit
+ *
+ * @Column(name="time_edit", type="timestamp", length=19, nullable=true)
+ * @Label(content="Time Edit")
+ * @var string
+ */
+ protected $timeEdit;
+
+ /**
+ * Admin Create
+ *
+ * @Column(name="admin_create", type="varchar(40)", length=40, nullable=true, updatable=false)
+ * @Label(content="Admin Create")
+ * @var string
+ */
+ protected $adminCreate;
+
+ /**
+ * Admin Edit
+ *
+ * @Column(name="admin_edit", type="varchar(40)", length=40, nullable=true)
+ * @Label(content="Admin Edit")
+ * @var string
+ */
+ protected $adminEdit;
+
+ /**
+ * IP Create
+ *
+ * @Column(name="ip_create", type="varchar(50)", length=50, nullable=true, updatable=false)
+ * @Label(content="IP Create")
+ * @var string
+ */
+ protected $ipCreate;
+
+ /**
+ * IP Edit
+ *
+ * @Column(name="ip_edit", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="IP Edit")
+ * @var string
+ */
+ protected $ipEdit;
+
+ /**
+ * Active
+ *
+ * @Column(name="active", type="tinyint(1)", length=1, default_value="1", nullable=true)
+ * @DefaultColumn(value="1")
+ * @Label(content="Active")
+ * @var boolean
+ */
+ protected $active;
+
+ /**
+ * As Draft
+ *
+ * @Column(name="as_draft", type="tinyint(1)", length=1, default_value="1", nullable=true)
+ * @DefaultColumn(value="1")
+ * @var boolean
+ */
+ protected $asDraft;
+
+}
+
+/**
+ * @Entity
+ * @JSON(property-naming-strategy=SNAKE_CASE, prettify=true)
+ * @Table(name="producer")
+ */
+class Producer extends MagicObject
+{
+ /**
+ * Producer ID
+ *
+ * @Id
+ * @GeneratedValue(strategy=GenerationType.UUID)
+ * @NotNull
+ * @Column(name="producer_id", type="varchar(40)", length=40, nullable=false)
+ * @Label(content="Producer ID")
+ * @var string
+ */
+ protected $producerId;
+
+ /**
+ * Name
+ *
+ * @Column(name="name", type="varchar(100)", length=100, nullable=true)
+ * @Label(content="Name")
+ * @var string
+ */
+ protected $name;
+
+ /**
+ * Gender
+ *
+ * @Column(name="gender", type="varchar(2)", length=2, nullable=true)
+ * @Label(content="Gender")
+ * @var string
+ */
+ protected $gender;
+
+ /**
+ * Birth Day
+ *
+ * @Column(name="birth_day", type="date", nullable=true)
+ * @Label(content="Birth Day")
+ * @var string
+ */
+ protected $birthDay;
+
+ /**
+ * Phone
+ *
+ * @Column(name="phone", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="Phone")
+ * @var string
+ */
+ protected $phone;
+
+ /**
+ * Phone2
+ *
+ * @Column(name="phone2", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="Phone2")
+ * @var string
+ */
+ protected $phone2;
+
+ /**
+ * Phone3
+ *
+ * @Column(name="phone3", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="Phone3")
+ * @var string
+ */
+ protected $phone3;
+
+ /**
+ * Email
+ *
+ * @Column(name="email", type="varchar(100)", length=100, nullable=true)
+ * @Label(content="Email")
+ * @var string
+ */
+ protected $email;
+
+ /**
+ * Email2
+ *
+ * @Column(name="email2", type="varchar(100)", length=100, nullable=true)
+ * @Label(content="Email2")
+ * @var string
+ */
+ protected $email2;
+
+ /**
+ * Email3
+ *
+ * @Column(name="email3", type="varchar(100)", length=100, nullable=true)
+ * @Label(content="Email3")
+ * @var string
+ */
+ protected $email3;
+
+ /**
+ * Website
+ *
+ * @Column(name="website", type="text", nullable=true)
+ * @Label(content="Website")
+ * @var string
+ */
+ protected $website;
+
+ /**
+ * Address
+ *
+ * @Column(name="address", type="text", nullable=true)
+ * @Label(content="Address")
+ * @var string
+ */
+ protected $address;
+
+ /**
+ * Picture
+ *
+ * @Column(name="picture", type="tinyint(1)", length=1, nullable=true)
+ * @var boolean
+ */
+ protected $picture;
+
+ /**
+ * Image Path
+ *
+ * @Column(name="image_path", type="text", nullable=true)
+ * @Label(content="Image Path")
+ * @var string
+ */
+ protected $imagePath;
+
+ /**
+ * Image Update
+ *
+ * @Column(name="image_update", type="timestamp", length=19, nullable=true)
+ * @Label(content="Image Update")
+ * @var string
+ */
+ protected $imageUpdate;
+
+ /**
+ * Time Create
+ *
+ * @Column(name="time_create", type="timestamp", length=19, nullable=true, updatable=false)
+ * @Label(content="Time Create")
+ * @var string
+ */
+ protected $timeCreate;
+
+ /**
+ * Time Edit
+ *
+ * @Column(name="time_edit", type="timestamp", length=19, nullable=true)
+ * @Label(content="Time Edit")
+ * @var string
+ */
+ protected $timeEdit;
+
+ /**
+ * Admin Create
+ *
+ * @Column(name="admin_create", type="varchar(40)", length=40, nullable=true, updatable=false)
+ * @Label(content="Admin Create")
+ * @var string
+ */
+ protected $adminCreate;
+
+ /**
+ * Admin Edit
+ *
+ * @Column(name="admin_edit", type="varchar(40)", length=40, nullable=true)
+ * @Label(content="Admin Edit")
+ * @var string
+ */
+ protected $adminEdit;
+
+ /**
+ * IP Create
+ *
+ * @Column(name="ip_create", type="varchar(50)", length=50, nullable=true, updatable=false)
+ * @Label(content="IP Create")
+ * @var string
+ */
+ protected $ipCreate;
+
+ /**
+ * IP Edit
+ *
+ * @Column(name="ip_edit", type="varchar(50)", length=50, nullable=true)
+ * @Label(content="IP Edit")
+ * @var string
+ */
+ protected $ipEdit;
+
+ /**
+ * Active
+ *
+ * @Column(name="active", type="tinyint(1)", length=1, default_value="1", nullable=true)
+ * @DefaultColumn(value="1")
+ * @Label(content="Active")
+ * @var boolean
+ */
+ protected $active;
+
+}
+
+$album = new EntityAlbum(null, $database);
+
+$subqueryMap = array(
+ 'producer'=>array(
+ 'entityName'=>'Producer',
+ 'tableName'=>'producer',
+ 'primaryKey'=>'producer_id',
+ 'columnName'=>'producer_id',
+ 'objectName'=>'producer',
+ 'propertyName'=>'name'
+ )
+);
+
+$result = $album->findAll(null, null, null, true, null, MagicObject::FIND_OPTION_NO_COUNT_DATA | MagicObject::FIND_OPTION_NO_FETCH_DATA);
+
+while($data = $result->fetch())
+{
+ echo $data;
+}