Class RelationLookup
The RelationLookup complex data type. Used to store object2object lookup tables for MANY-TO-MANY relationships between record objects.
- Alpha\Model\ActiveRecord
-
Alpha\Model\Type\RelationLookup implements Alpha\Model\Type\TypeInterface
Copyright:
Copyright (c) 2018, John Collins (founder of Alpha Framework). All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Alpha Framework nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Model/Type/RelationLookup.php
Methods summary
public
|
|
public
string
|
|
public
string
|
|
public
string
|
#
getTableName( )
Custom getter for the TABLE_NAME, which can't be static in this class due to the lookup tablenames being different each time. |
public
array
|
#
loadAllByAttribute( string $attribute, string $value, integer $start = 0, integer $limit = 0, string $orderBy = 'ID', string $order = 'ASC', boolean $ignoreClassType = false, array $constructorArgs = array() )
This custom version provides the left/right class names to the business object constructor, required for RelationLookup objects. |
public
array
|
#
loadAllByAttributes( array $attributes = array(), array $values = array(), integer $start = 0, integer $limit = 0, string $orderBy = 'ID', string $order = 'ASC', boolean $ignoreClassType = false )
This custom version provides the left/right class names to the business object constructor, required for RelationLookup objects. |
public
string
|
|
public
|
|
public
integer[]
|
|
public
|
|
public
string
|
Methods inherited from Alpha\Model\ActiveRecord
__wakeup()
,
addProperty()
,
addToCache()
,
backupDatabase()
,
begin()
,
cast()
,
checkDatabaseExists()
,
checkRecordExists()
,
checkRecordTableExists()
,
checkTableExists()
,
checkTableNeedsUpdate()
,
commit()
,
createDatabase()
,
createForeignIndex()
,
createUniqueIndex()
,
delete()
,
deleteAllByAttribute()
,
disconnect()
,
dropDatabase()
,
dropTable()
,
findMissingFields()
,
get()
,
getCount()
,
getCreateTS()
,
getCreatorId()
,
getDataLabel()
,
getDataLabels()
,
getDefaultAttributes()
,
getFriendlyClassName()
,
getHistoryCount()
,
getID()
,
getIndexes()
,
getLastQuery()
,
getMAX()
,
getMaintainHistory()
,
getPersistentAttributes()
,
getPropObject()
,
getRecordClassNames()
,
getTaggedAttributes()
,
getTransientAttributes()
,
getUniqueAttributes()
,
getUpdateTS()
,
getUpdatorId()
,
getVersion()
,
getVersionNumber()
,
hasAttribute()
,
isInstalled()
,
isTableOverloaded()
,
isTagged()
,
isTransient()
,
load()
,
loadAll()
,
loadAllByDayUpdated()
,
loadAllFieldValuesByAttribute()
,
loadAllOldVersions()
,
loadByAttribute()
,
loadClassDef()
,
loadFromCache()
,
makeHistoryTable()
,
makeTable()
,
markPersistent()
,
markTransient()
,
markUnique()
,
populateFromArray()
,
query()
,
rebuildTable()
,
reload()
,
removeFromCache()
,
rollback()
,
save()
,
saveAttribute()
,
saveHistory()
,
saveRelations()
,
set()
,
setDataLabels()
,
setEnumOptions()
,
setID()
,
setLastQuery()
,
setMaintainHistory()
,
toArray()
,
validate()
Properties summary
protected
|
$leftID
The ID of the left business object in the relation. |
|
protected
|
$rightID
The ID of the right business object in the relation. |
|
protected
array
|
$dataLabels
an array of data display labels for the class properties. |
#
array('ID' => 'RelationLookup ID#', 'leftID' => 'Left Record ID#', 'rightID' => 'Right Record ID#')
|
protected
string
|
$helper
The message to display to the user when validation fails. |
#
'Not a valid RelationLookup value!'
|
Properties inherited from Alpha\Model\ActiveRecord
$ID
,
$created_by
,
$created_ts
,
$defaultAttributes
,
$lastQuery
,
$transientAttributes
,
$uniqueAttributes
,
$updated_by
,
$updated_ts
,
$version_num