Handling the value in certain field of certain row.
Kenttä -object can be referred through
Page -objects property or method that returns field(s).
Use examples
Value change
Show feedback, if 'Status' -field value is changed to value 'New'.
if ( $Order->status->isChanged() && $Order->status->oldValue() == 'New' ){
$this->get("notification","Status is changed from New to {$Order->status->getValue()}");
}
Calculating with field value
Field has a Field::getNumber() -method, that returns the countable presentation of value in field. For example duration Duration -fields value 01:15 is 1.25 as countable number.
Calculate total from work hours and employees hour rate:
$total = $Workhour->hours->getNumber() * $Workhour->employee->hour_rate->getNumber();
Page::calculate() -method uses the Field::getNumber() values. Example above can also be written:
$total = $Workhour->calculate('hours * employee.hour_rate');
Fieldtype methods and attributes
Osalla kentistä on omia kenttätyyppikohtaisia metodeita kentän tietojen käsittelyyn.
Tiedosto -kentän 240x240 esikatselukuvan näyttäminen:
$txt .= "<img src='{$Product->product_image->thumb}&s=240'/>";
Liitos -sivun tiedon näyttäminen; projektin asiakkaan nimi:
$name = $Order->client->getPage()->name;
Jos liitos -kentältä pyydetään atribuuttia, palautetaan kohdesivun atribuutti eli liitetyn sivun pyydetyn kentän Kentta -olio. Edellisen voi siis kirjoittaa myös:
$name = $Order->client->namne;
Vitte -field can refer to all pages that are linked to this page.
Loop through multiple pages: Show all orders where this client is customer:
foreach ( $Client->order__customer->getPages() as $Order ){
$txt .= "<p>{$Order->order_number} {$Order->delivery_date}</p>";
}
Methods Field getId()
Technical id of the field
Yksi Kaksi Kolme Neljä Viisi
getName()
Technical name of the field
Yksi Kaksi Kolme Neljä Viisi
getTitle()
Visible title of the field
Yksi Kaksi Kolme Neljä Viisi
getType()
Type of the field type
Yksi Kaksi Kolme Neljä Viisi
isType($type[,$type...])
Check if field is given type
Yksi Kaksi Kolme Neljä Viisi
isUse($usetype[,$usetype...])
Check if field implements given use
Yksi Kaksi Kolme Neljä Viisi
getMaxValue()
Max value in field
Yksi Kaksi Kolme Neljä Viisi
getMinValue()
Min value in field
Yksi Kaksi Kolme Neljä Viisi
getPrivilege()
Get user privilege for field
Yksi Kaksi Kolme Neljä Viisi
isFixed()
Check if field is a fixed field
Yksi Kaksi Kolme Neljä Viisi
isPrivilege([$level])
Check if user has given privilege
Yksi Kaksi Kolme Neljä Viisi
getUniqueValue()
Get all unique values in field
Yksi Kaksi Kolme Neljä Viisi
Tiedot getPreference($name)
Field preference
Yksi Kaksi Kolme Neljä Viisi
getTableField()
Get field information
Yksi Kaksi Kolme Neljä Viisi
getPage()
Get the page field is in
Yksi Kaksi Kolme Neljä Viisi
getTable()
Get the table field is in
Yksi Kaksi Kolme Neljä Viisi
newSelectStatement([$params])
Get the table field is in
Yksi Kaksi Kolme Neljä Viisi
tyyppi: aikaleima getHm()
Get hh:mm of time
Yksi Kaksi Kolme Neljä Viisi
getTime()
Time value in as Time -object
Yksi Kaksi Kolme Neljä Viisi
tyyppi: henkilo birthday
Henkilön syntymäpäivä
Yksi Kaksi Kolme Neljä Viisi
firstname
Henkilön etunimi
Yksi Kaksi Kolme Neljä Viisi
lastname
Henkilön sukunimi
Yksi Kaksi Kolme Neljä Viisi
sex
Henkilön sukupuoli
Yksi Kaksi Kolme Neljä Viisi
socialsecuritynumber, idnumber
Henkilön henkilötunnus
Yksi Kaksi Kolme Neljä Viisi
tyyppi: kayttaja getUser()
User object
Yksi Kaksi Kolme Neljä Viisi
tyyppi: kommentti getNewest()
Get the newest comment
Yksi Kaksi Kolme Neljä Viisi
getOldest()
Get the oldest comment
Yksi Kaksi Kolme Neljä Viisi
tyyppi: liitos fieldname
Joined pages
Yksi Kaksi Kolme Neljä Viisi
sivu()
Joined page
Yksi Kaksi Kolme Neljä Viisi
kansio()
Return pages
Yksi Kaksi Kolme Neljä Viisi
newRow([$values])
Create and add new page
Yksi Kaksi Kolme Neljä Viisi
setValue($param)
Set page
Yksi Kaksi Kolme Neljä Viisi
addValue([$param,...])
Add new page
Yksi Kaksi Kolme Neljä Viisi
addValues($array)
Add multiple pages
Yksi Kaksi Kolme Neljä Viisi
tyyppi: luku unit
Number unit
Yksi Kaksi Kolme Neljä Viisi
value
Number value
Yksi Kaksi Kolme Neljä Viisi
tyyppi: monivalinta getOption([$value])
Get field select option
Yksi Kaksi Kolme Neljä Viisi
getOptions()
Get field select options
Yksi Kaksi Kolme Neljä Viisi
tyyppi: note addValue($param)
Add new note
Yksi Kaksi Kolme Neljä Viisi
tyyppi: osoite streetaddress
Address streetaddress
Yksi Kaksi Kolme Neljä Viisi
streetaddress2
Address streetaddress2
Yksi Kaksi Kolme Neljä Viisi
boxnumber
Address boxnumber
Yksi Kaksi Kolme Neljä Viisi
postcode
Address postcode
Yksi Kaksi Kolme Neljä Viisi
town
Address town
Yksi Kaksi Kolme Neljä Viisi
country
Address country
Yksi Kaksi Kolme Neljä Viisi
tyyppi: paiva getDateReference()
Reference to value in eDate object
Yksi Kaksi Kolme Neljä Viisi
anyDateMethod()
Any method available in eDate class
Yksi Kaksi Kolme Neljä Viisi
tyyppi: puhelin getPhone()
Get validated number
Yksi Kaksi Kolme Neljä Viisi
parsePhone($string)
Parse numbers from given string
Yksi Kaksi Kolme Neljä Viisi
tyyppi: raha currency
Curency name
Yksi Kaksi Kolme Neljä Viisi
exchange_rate
Valuuttakurssi suhteessa pohjavaluuttaan
Yksi Kaksi Kolme Neljä Viisi
exchange_rate_date
Valuuttakurssin päivämäärä
Yksi Kaksi Kolme Neljä Viisi
vat, vat_percent
Hinnan alv prosentti
Yksi Kaksi Kolme Neljä Viisi
vat_amount
Hinnan alv osuus pohjavaluutassa
Yksi Kaksi Kolme Neljä Viisi
vat_amount_comma
Hinnan alv osuus pohjavaluutassa, desimaalipilkulla
Yksi Kaksi Kolme Neljä Viisi
vat_excluded
Hinnan alviton summa pohjavaluutassa
Yksi Kaksi Kolme Neljä Viisi
vat_excluded_comma
Hinnan alviton summa pohjavaluutassa, desimaalipilkulla
Yksi Kaksi Kolme Neljä Viisi
vat_included
Hinnan alvillinen summa pohjavaluutassa
Yksi Kaksi Kolme Neljä Viisi
vat_included_comma
Hinnan alvillinen summa pohjavaluutassa, desimaalipilkulla
Yksi Kaksi Kolme Neljä Viisi
tyyppi: salasana generatePassword([$length])
Generate new password string
Yksi Kaksi Kolme Neljä Viisi
tyyppi: tiedosto file
Path to file on server
Yksi Kaksi Kolme Neljä Viisi
filename
Name of the file
Yksi Kaksi Kolme Neljä Viisi
filesize
Filesize
Yksi Kaksi Kolme Neljä Viisi
filetype
filetype
Yksi Kaksi Kolme Neljä Viisi
height
Image height
Yksi Kaksi Kolme Neljä Viisi
imagesize
Image widthxheight
Yksi Kaksi Kolme Neljä Viisi
thumb
Thumbnail src
Yksi Kaksi Kolme Neljä Viisi
width
Image width
Yksi Kaksi Kolme Neljä Viisi
addValue($file[,$method])
Add new file
Yksi Kaksi Kolme Neljä Viisi
getFile()
Return File object
Yksi Kaksi Kolme Neljä Viisi
getFiles()
Return list of File objects
Yksi Kaksi Kolme Neljä Viisi
url_salattu
Link to file
Yksi Kaksi Kolme Neljä Viisi
tyyppi: todo addValue($param)
Add new todo
Yksi Kaksi Kolme Neljä Viisi
tyyppi: url url
Link url
Yksi Kaksi Kolme Neljä Viisi
tyyppi: viite folder()
Referring pages
Yksi Kaksi Kolme Neljä Viisi
sivu()
Referring page
Yksi Kaksi Kolme Neljä Viisi
tyyppi: yritys businessid
Yrityksen Y-tunnus
Yksi Kaksi Kolme Neljä Viisi
founded
Yrityksen perustamispäivä
Yksi Kaksi Kolme Neljä Viisi
name
Yrityksen nimi
Yksi Kaksi Kolme Neljä Viisi
Value getAddedValues()
Get values added to field
Yksi Kaksi Kolme Neljä Viisi
getAmount()
Mathematical value
Yksi Kaksi Kolme Neljä Viisi
getApiValue()
Value that is returned in API
Yksi Kaksi Kolme Neljä Viisi
getChangedValues()
Get values that were added or removed
Yksi Kaksi Kolme Neljä Viisi
getOldValue()
Value before change
Yksi Kaksi Kolme Neljä Viisi
getOldValues()
Get values that were selected before editing
Yksi Kaksi Kolme Neljä Viisi
getRelatedValues()
Get old values and new values
Yksi Kaksi Kolme Neljä Viisi
getRemovedValues()
Get values that were removed
Yksi Kaksi Kolme Neljä Viisi
getUnit()
Field value
Yksi Kaksi Kolme Neljä Viisi
getValue()
Technical value
Yksi Kaksi Kolme Neljä Viisi
getValues()
Technical values
Yksi Kaksi Kolme Neljä Viisi
getNumber()
Value in number format
Yksi Kaksi Kolme Neljä Viisi
getInitial()
First letter of the text format
Yksi Kaksi Kolme Neljä Viisi
getText()
Value in simple text format
Yksi Kaksi Kolme Neljä Viisi
nayta()
Value in html
Yksi Kaksi Kolme Neljä Viisi
getUiInput()
Edit field value.
Yksi Kaksi Kolme Neljä Viisi
getCategoryValue($params)
Value that is used as category
Yksi Kaksi Kolme Neljä Viisi
muokkaa([$render])
Show value, click to edit
Yksi Kaksi Kolme Neljä Viisi
Value change isChangedBackPast()
Check if value has been modified back past given value
Yksi Kaksi Kolme Neljä Viisi
isChangedOver()
Check if value has been modified again
Yksi Kaksi Kolme Neljä Viisi
isChangedPast()
Check if value has been modified past given value
Yksi Kaksi Kolme Neljä Viisi
isInserted()
Check if value has been modifyed for first time
Yksi Kaksi Kolme Neljä Viisi
isChanged()
Check if value has been modifyed
Yksi Kaksi Kolme Neljä Viisi
isChangedTo($value[,$value...])
Check if value has been changed to given value.
Yksi Kaksi Kolme Neljä Viisi
isChangedFrom($value[,$value...])
Check if value has been modified from given value
Yksi Kaksi Kolme Neljä Viisi
notChanged()
Check if value has not been modifyed
Yksi Kaksi Kolme Neljä Viisi
isCleared()
Check if value in field is removed
Yksi Kaksi Kolme Neljä Viisi
getChange()
Return the amount of the value change
Yksi Kaksi Kolme Neljä Viisi
Value comparison isEmpty()
Check if field has no value
Yksi Kaksi Kolme Neljä Viisi
wasEmpty()
Check if field had no value
Yksi Kaksi Kolme Neljä Viisi
isValue([$value,$value,...])
Check if field has a given value
Yksi Kaksi Kolme Neljä Viisi
isGiven()
Check if field has a valid value
Yksi Kaksi Kolme Neljä Viisi
wasGiven()
Check if field had a valid value
Yksi Kaksi Kolme Neljä Viisi
hasValue([$value,$value,...])
Check if field has a given value
Yksi Kaksi Kolme Neljä Viisi
hasString($string[,$string,...])
Check if field has a given value
Yksi Kaksi Kolme Neljä Viisi
isUnder($value)
Check if value is smaller than given value
Yksi Kaksi Kolme Neljä Viisi
isUnderOr($value)
Check if value is smaller or same as given value
Yksi Kaksi Kolme Neljä Viisi
isBefore($value)
Check if value is smaller than given value
Yksi Kaksi Kolme Neljä Viisi
isBeforeOr($value)
Check if value is smaller or same as given value
Yksi Kaksi Kolme Neljä Viisi
isAfter($value)
Check if value is greater than given value
Yksi Kaksi Kolme Neljä Viisi
isAfterOr($value)
Check if value is greater or same as given value
Yksi Kaksi Kolme Neljä Viisi
isOver($value)
Check if value is greater than given value
Yksi Kaksi Kolme Neljä Viisi
isOverOr($value)
Check if value is greater or same as given value
Yksi Kaksi Kolme Neljä Viisi
isBetween($start,$end)
Check if value is between given range
Yksi Kaksi Kolme Neljä Viisi
Value modify setValue($value)
Set value to field
Yksi Kaksi Kolme Neljä Viisi
setDefault($value)
Set value if field has no value
Yksi Kaksi Kolme Neljä Viisi
addValue($value)
Add value to fields current value
Yksi Kaksi Kolme Neljä Viisi
calculateValue($formula[,$decimals,$debug])
Set calculated value
Yksi Kaksi Kolme Neljä Viisi
removeValue($value)
Remove given value from field
Yksi Kaksi Kolme Neljä Viisi
setEmpty()
Clear value in field
Yksi Kaksi Kolme Neljä Viisi
undoChange()
Revert to original value
Yksi Kaksi Kolme Neljä Viisi
Value utility isSameValue($value1,$value2)
Check if values are the same
Yksi Kaksi Kolme Neljä Viisi
isEmptyValue($value)
Check if given value is empty
Yksi Kaksi Kolme Neljä Viisi
convertToValue($value)
Convert given parameter to valid value
Yksi Kaksi Kolme Neljä Viisi