blocks|key|2801860|text|如果您将getAvailability()方法重命名为getAvailableAttribute()，您的方法将成为一个访问器，并且您将能够直接在模型上使用->available读取它。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|BOLD|entityRanges|data|2801861|文档：https://laravel.com/docs/5.4/eloquent-mutators#accessors-and-mutators|2801862|编辑:由于您的属性是“虚拟的”，因此默认情况下，它不会包含在对象的JSON表示中。|2801863|但我发现了这个：Custom+model+accessors+not+processed+when+->toJson()+called?++|2801864|为了强制在数组中返回属性，请将其作为键添加到$attributes数组中。|2801865|class+User+extends+Eloquent+{
++++protected+$attributes+=+array(
++++++++'ZipCode'+=>+'',
++++);

++++public+function+getZipCodeAttribute()
++++{
++++++++return+....
++++}
}|code-block|syntax|javascript|2801866|我没有对其进行测试，但对于您在当前的设置中进行尝试来说，应该是相当简单的。|2801867|entityMap|0|LINK|mutability|MUTABLE|url|https://laravel.com/docs/5.4/eloquent-mutators#accessors-and-mutators|1|https://github.com/laravel/framework/issues/112^0|4|H|R|N|26|B|1O|3|0|3|1X|0|0|0|8|1Q|1|0|0|0|0^^$0|@$1|2|3|4|5|6|7|15|8|@$9|16|A|17|B|C]|$9|18|A|19|B|C]|$9|1A|A|1B|B|C]|$9|1C|A|1D|B|D]]|E|@]|F|$]]|$1|G|3|H|5|6|7|1E|8|@]|E|@$9|1F|A|1G|1|1H]]|F|$]]|$1|I|3|J|5|6|7|1I|8|@]|E|@]|F|$]]|$1|K|3|L|5|6|7|1J|8|@]|E|@$9|1K|A|1L|1|1M]]|F|$]]|$1|M|3|N|5|6|7|1N|8|@]|E|@]|F|$]]|$1|O|3|P|5|Q|7|1O|8|@]|E|@]|F|$R|S]]|$1|T|3|U|5|6|7|1P|8|@]|E|@]|F|$]]|$1|V|3|-4|5|6|7|1Q|8|@]|E|@]|F|$]]]|W|$X|$5|Y|Z|10|F|$11|12]]|13|$5|Y|Z|10|F|$11|14]]]]

If you rename your <code>getAvailability()</code> method to <code>getAvailableAttribute()</code> your method becomes an accessor and you'll be able to read it using <code>-&gt;available</code> straight on your model.

Docs: <a href="https://laravel.com/docs/5.4/eloquent-mutators#accessors-and-mutators" rel="noreferrer">https://laravel.com/docs/5.4/eloquent-mutators#accessors-and-mutators</a>

EDIT: Since your attribute is "virtual", it is not included by default in the JSON representation of your object.

But I found this: <a href="https://github.com/laravel/framework/issues/112" rel="noreferrer">Custom model accessors not processed when ->toJson() called? </a>

In order to force your attribute to be returned in the array, add it as a key to the $attributes array.

<pre><code>class User extends Eloquent {
 protected $attributes = array(
 'ZipCode' =&gt; '',
 );

 public function getZipCodeAttribute()
 {
 return ....
 }
}
</code></pre>

I didn't test it, but should be pretty trivial for you to try in your current setup.

blocks|key|3014087|text|该问题是由于Model的toArray()方法忽略了与底层表中的列不直接相关的任何访问器造成的。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|3014088|正如Taylor+Otwell提到的here，“这是有意的，并且是出于性能原因。”然而，有一种简单的方法可以实现这一点：|3014089|class+EventSession+extends+Eloquent+{

++++protected+$table+=+'sessions';
++++protected+$appends+=+array('availability');

++++public+function+getAvailabilityAttribute()
++++{
++++++++return+$this->calculateAvailability();++
++++}
}|code-block|syntax|javascript|3014090|只要您添加了适当的访问器，$appends属性中列出的任何属性都将自动包含在模型的数组或JSON形式中。|3014091|旧答案(适用于Laravel版本<+4.08):|BOLD|3014092|我找到的最好的解决方案是覆盖toArray()方法，并显式设置属性：|3014093|class+Book+extends+Eloquent+{

++++protected+$table+=+'books';

++++public+function+toArray()
++++{
++++++++$array+=+parent::toArray();
++++++++$array['upper']+=+$this->upper;
++++++++return+$array;
++++}

++++public+function+getUpperAttribute()
++++{
++++++++return+strtoupper($this->title);++++
++++}

}|3014094|或者，如果您有许多自定义访问器，请遍历所有这些访问器并应用它们：|3014095|class+Book+extends+Eloquent+{

++++protected+$table+=+'books';

++++public+function+toArray()
++++{
++++++++$array+=+parent::toArray();
++++++++foreach+($this->getMutatedAttributes()+as+$key)
++++++++{
++++++++++++if+(+!+array_key_exists($key,+$array))+{
++++++++++++++++$array[$key]+=+$this->{$key};+++
++++++++++++}
++++++++}
++++++++return+$array;
++++}

++++public+function+getUpperAttribute()
++++{
++++++++return+strtoupper($this->title);++++
++++}

}|3014096|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/laravel/framework/issues/112#issuecomment-12530987^0|6|5|C|9|0|I|4|0|0|0|0|0|O|0|E|9|0|0|0|0^^$0|@$1|2|3|4|5|6|7|17|8|@$9|18|A|19|B|C]|$9|1A|A|1B|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|1C|8|@]|D|@$9|1D|A|1E|1|1F]]|E|$]]|$1|H|3|I|5|J|7|1G|8|@]|D|@]|E|$K|L]]|$1|M|3|N|5|6|7|1H|8|@]|D|@]|E|$]]|$1|O|3|P|5|6|7|1I|8|@$9|1J|A|1K|B|Q]]|D|@]|E|$]]|$1|R|3|S|5|6|7|1L|8|@$9|1M|A|1N|B|C]]|D|@]|E|$]]|$1|T|3|U|5|J|7|1O|8|@]|D|@]|E|$K|L]]|$1|V|3|W|5|6|7|1P|8|@]|D|@]|E|$]]|$1|X|3|Y|5|J|7|1Q|8|@]|D|@]|E|$K|L]]|$1|Z|3|-4|5|6|7|1R|8|@]|D|@]|E|$]]]|10|$11|$5|12|13|14|E|$15|16]]]]

The problem is caused by the fact that the <code>Model</code>'s <code>toArray()</code> method ignores any accessors which do not directly relate to a column in the underlying table.

As Taylor Otwell mentioned <a href="https://github.com/laravel/framework/issues/112#issuecomment-12530987">here</a>, "This is intentional and for performance reasons." However there is an easy way to achieve this:

<pre><code>class EventSession extends Eloquent {

 protected $table = 'sessions';
 protected $appends = array('availability');

 public function getAvailabilityAttribute()
 {
 return $this-&gt;calculateAvailability(); 
 }
}
</code></pre>

Any attributes listed in the $appends property will automatically be included in the array or JSON form of the model, provided that you've added the appropriate accessor.

Old answer (for Laravel versions &lt; 4.08):

The best solution that I've found is to override the <code>toArray()</code> method and either explicity set the attribute:

<pre><code>class Book extends Eloquent {

 protected $table = 'books';

 public function toArray()
 {
 $array = parent::toArray();
 $array['upper'] = $this-&gt;upper;
 return $array;
 }

 public function getUpperAttribute()
 {
 return strtoupper($this-&gt;title); 
 }

}
</code></pre>

or, if you have lots of custom accessors, loop through them all and apply them:

<pre><code>class Book extends Eloquent {

 protected $table = 'books';

 public function toArray()
 {
 $array = parent::toArray();
 foreach ($this-&gt;getMutatedAttributes() as $key)
 {
 if ( ! array_key_exists($key, $array)) {
 $array[$key] = $this-&gt;{$key}; 
 }
 }
 return $array;
 }

 public function getUpperAttribute()
 {
 return strtoupper($this-&gt;title); 
 }

}
</code></pre>

blocks|key|2802008|text|last+thing+on+the+Laravel+Eloquent+doc+page为：|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|2802009|protected+$appends+=+array('is_admin');|code-block|syntax|javascript|2802010|它可以自动用于向模型中添加新的访问器，而无需任何额外的工作，如修改::toArray()等方法。|style|CODE|2802011|只需创建getFooBarAttribute(...)访问器并将foo_bar添加到$appends数组。|2802012|entityMap|0|LINK|mutability|MUTABLE|url|https://laravel.com/docs/eloquent-serialization#appending-values-to-json^0|0|17|0|0|0|X|B|0|4|N|W|7|16|8|0^^$0|@$1|2|3|4|5|6|7|W|8|@]|9|@$A|X|B|Y|1|Z]]|C|$]]|$1|D|3|E|5|F|7|10|8|@]|9|@]|C|$G|H]]|$1|I|3|J|5|6|7|11|8|@$A|12|B|13|K|L]]|9|@]|C|$]]|$1|M|3|N|5|6|7|14|8|@$A|15|B|16|K|L]|$A|17|B|18|K|L]|$A|19|B|1A|K|L]]|9|@]|C|$]]|$1|O|3|-4|5|6|7|1B|8|@]|9|@]|C|$]]]|P|$Q|$5|R|S|T|C|$U|V]]]]

The <a href="https://laravel.com/docs/eloquent-serialization#appending-values-to-json" rel="noreferrer">last thing on the Laravel Eloquent doc page</a> is:

<pre><code>protected $appends = array('is_admin');
</code></pre>

That can be used automatically to add new accessors to the model without any additional work like modifying methods like <code>::toArray()</code>. 

Just create <code>getFooBarAttribute(...)</code> accessor and add the <code>foo_bar</code> to <code>$appends</code> array.

blocks|key|185644|text|您可以使用模型中的setAttribute函数来添加自定义属性|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|185645|entityMap^0|9|C|0^^$0|@$1|2|3|4|5|6|7|H|8|@$9|I|A|J|B|C]]|D|@]|E|$]]|$1|F|3|-4|5|6|7|K|8|@]|D|@]|E|$]]]|G|$]]

you can use <code>setAttribute</code> function in Model to add a custom attribute

blocks|key|2802028|text|我有一些类似的东西:我在我的模型中有一个属性图片，它包含文件在存储文件夹中的位置。返回的图像必须经过base64编码|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2802029|//Add+extra+attribute
protected+$attributes+=+['picture_data'];

//Make+it+available+in+the+json+response
protected+$appends+=+['picture_data'];

//implement+the+attribute
public+function+getPictureDataAttribute()
{
++++$file+=+Storage::get($this->picture);
++++$type+=+Storage::mimeType($this->picture);
++++return+"data:"+.+$type+.+";base64,"+.+base64_encode($file);
}|code-block|syntax|javascript|2802030|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

I had something simular:
I have an attribute picture in my model, this contains the location of the file in the Storage folder.
The image must be returned base64 encoded

<pre><code>//Add extra attribute
protected $attributes = ['picture_data'];

//Make it available in the json response
protected $appends = ['picture_data'];

//implement the attribute
public function getPictureDataAttribute()
{
 $file = Storage::get($this-&gt;picture);
 $type = Storage::mimeType($this-&gt;picture);
 return "data:" . $type . ";base64," . base64_encode($file);
}
</code></pre>

blocks|key|2802050|text|在我的例子中，创建一个空列并设置它的访问器工作得很好。我的访问者填写了用户的年龄，从道布专栏。toArray()函数也起作用了。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2802051|public+function+getAgeAttribute()
{
++return+Carbon::createFromFormat('Y-m-d',+$this->attributes['dateofbirth'])->age;
}|code-block|syntax|javascript|2802052|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

in my case, creating an empty column and setting its accessor worked fine.
my accessor filling user's age from dob column. toArray() function worked too.

<pre><code>public function getAgeAttribute()
{
 return Carbon::createFromFormat('Y-m-d', $this-&gt;attributes['dateofbirth'])-&gt;age;
}
</code></pre>

blocks|key|185026|text|在我的订阅模型中，我需要知道订阅是否暂停。下面是我是如何做到的|type|unstyled|depth|inlineStyleRanges|entityRanges|data|185027|public+function+getIsPausedAttribute()+{
++++$isPaused+=+false;
++++if+(!$this->is_active)+{
++++++++$isPaused+=+true;
++++}
}|code-block|syntax|javascript|185028|然后在视图模板中，我可以使用$subscription->is_paused来获得结果。|offset|length|style|CODE|185029|getIsPausedAttribute是设置自定义属性的格式，|185030|并使用is_paused来获取或使用视图中的属性。|185031|entityMap^0|0|0|E|O|0|0|K|0|3|9|0^^$0|@$1|2|3|4|5|6|7|S|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|T|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|U|8|@$I|V|J|W|K|L]]|9|@]|A|$]]|$1|M|3|N|5|6|7|X|8|@$I|Y|J|Z|K|L]]|9|@]|A|$]]|$1|O|3|P|5|6|7|10|8|@$I|11|J|12|K|L]]|9|@]|A|$]]|$1|Q|3|-4|5|6|7|13|8|@]|9|@]|A|$]]]|R|$]]

In my subscription model, I need to know the subscription is paused or not.
here is how I did it

<pre><code>public function getIsPausedAttribute() {
 $isPaused = false;
 if (!$this-&gt;is_active) {
 $isPaused = true;
 }
}
</code></pre>

then in the view template,I can use 
<code>$subscription-&gt;is_paused</code> to get the result. 

The <code>getIsPausedAttribute</code> is the format to set a custom attribute,

and uses <code>is_paused</code> to get or use the attribute in your view.

blocks|key|2802151|text|假设您的users表中有两列，分别名为first_name和last_name，并且您希望检索全名。您可以使用以下代码来实现：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2802152|class+User+extends+Eloquent+{


++++public+function+getFullNameAttribute()
++++{
++++++++return+$this->first_name.'+'.$this->last_name;
++++}
}|code-block|syntax|javascript|2802153|现在，您可以获得全名：|2802154|$user+=+User::find(1);
$user->full_name;|2802155|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|N|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|O|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|P|8|@]|9|@]|A|$E|F]]|$1|K|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|L|$]]

Let say you have 2 columns named first_name and last_name in your users table and you want to retrieve full name. you can achieve with the following code :

<pre><code>class User extends Eloquent {


 public function getFullNameAttribute()
 {
 return $this-&gt;first_name.' '.$this-&gt;last_name;
 }
}
</code></pre>

now you can get full name as:

<pre><code>$user = User::find(1);
$user-&gt;full_name;
</code></pre>

blocks|key|185720|text|步骤1:在$appends中定义属性|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|185721|步骤2:为属性定义访问器。|185722|示例：|185723|<?php
...

class+Movie+extends+Model{

++++protected+$appends+=+['cover'];

++++//define+accessor
++++public+function+getCoverAttribute()
++++{
++++++++return+json_decode($this->InJson)->cover;
++++}|code-block|syntax|javascript|185724|entityMap^0|5|8|0|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@$9|R|A|S|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|T|8|@]|D|@]|E|$]]|$1|H|3|I|5|6|7|U|8|@]|D|@]|E|$]]|$1|J|3|K|5|L|7|V|8|@]|D|@]|E|$M|N]]|$1|O|3|-4|5|6|7|W|8|@]|D|@]|E|$]]]|P|$]]

Step 1: Define attributes in <code>$appends</code> 
Step 2: Define accessor for that attributes. 
Example:

<pre class="lang-php prettyprint-override"><code>&lt;?php
...

class Movie extends Model{

 protected $appends = ['cover'];

 //define accessor
 public function getCoverAttribute()
 {
 return json_decode($this-&gt;InJson)-&gt;cover;
 }

</code></pre>

I'd like to be able to add a custom attribute/property to an Laravel/Eloquent model when it is loaded, similar to how that might be achieved with <a href="http://redbeanphp.com/manual/models_and_fuse">RedBean's</a> <code>$model-&gt;open()</code> method.

For instance, at the moment, in my controller I have:

<pre><code>public function index()
{
 $sessions = EventSession::all();
 foreach ($sessions as $i =&gt; $session) {
 $sessions[$i]-&gt;available = $session-&gt;getAvailability();
 }
 return $sessions;
}
</code></pre>

It would be nice to be able to omit the loop and have the 'available' attribute already set and populated.

I've tried using some of the model events described in the documentation to attach this property when the object loads, but without success so far.

Notes:

<ul>
<li>'available' is not a field in the underlying table.</li>
<li><code>$sessions</code> is being returned as a JSON object as part of an API, and therefore calling something like <code>$session-&gt;available()</code> in a template isn't an option</li>
</ul>

Add a custom attribute to a Laravel / Eloquent model on load?

JSON

我希望能够在加载Laravel/Eloquent模型时向其添加自定义属性/属性，这类似于使用 $model->open()方法可以实现的方式。例如，目前在我的控制器中，我有：public function index(){    $sessions = EventSession::all();    foreach (...

问在加载时向Laravel / Eloquent模型添加自定义属性？
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问在加载时向Laravel / Eloquent模型添加自定义属性？EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问在加载时向Laravel / Eloquent模型添加自定义属性？
EN