/**
* @param ManyManyList $products
*/
public function updateRelatedProducts(&$products, $limit, $random)
{
$curCount = $products->count();
if ($curCount < $limit) {
$cfg = Config::inst()->forClass(get_class($this->owner));
$class = $cfg->get('related_products_class');
// look up the fields
$fields = $cfg->get('related_products_fields');
if (empty($fields)) {
return;
}
if (!is_array($fields)) {
$fields = array($fields);
}
// create a filter from the fields
$filter = array();
foreach ($fields as $f) {
$filter[$f] = $this->owner->getField($f);
}
// Convert to an array list so we can add to it
$products = new ArrayList($products->toArray());
// Look up products that match the filter
$generated = DataObject::get($class)->filterAny($filter)->exclude('ID', $this->owner->ID)->sort('RAND()')->limit($limit - $curCount);
foreach ($generated as $prod) {
$products->push($prod);
}
}
}
/**
* Overloading ManyManyList removeByID Rather Then remove() as That Just Calls removeByID()
* Remove the given item from this list.
* Note that for a ManyManyList, the item is never actually deleted, only the join table is affected
* @param $itemID The item it
*/
public function removeByID($itemID)
{
parent::removeByID($itemID);
// Get Item Object Itself Based on $itemID
$dl = new DataList($this->dataClass);
// Must Include Table Prefix To Prevent "Column 'ID' in where clause is ambiguous" Error
$item = $dl->where("\"" . $this->dataClass . "\".\"ID\" = '" . $itemID . "'")->first();
$this->onUnlink($item);
}
public function getManyManyComponents($componentName, $filter = "", $sort = "", $join = "", $limit = "")
{
list($parentClass, $componentClass, $parentField, $componentField, $table) = $this->many_many($componentName);
// If we haven't been written yet, we can't save these relations, so use a list that handles this case
if (!$this->ID) {
if (!isset($this->unsavedRelations[$componentName])) {
$this->unsavedRelations[$componentName] = UnsavedRelationList::create($parentClass, $componentName, $componentClass);
}
return $this->unsavedRelations[$componentName];
}
$result = ManyManyList::create($componentClass, $table, $componentField, $parentField, $this->many_many_extraFields($componentName));
if ($this->model) {
$result->setDataModel($this->model);
}
// If this is called on a singleton, then we return an 'orphaned relation' that can have the
// foreignID set elsewhere.
$result = $result->forForeignID($this->ID);
return $result->where($filter)->sort($sort)->limit($limit);
}
/**
* Get an array of all of the editable fields for the view template
*
* @return ManyManyList
*/
public function getEditableFields()
{
if (null === $this->editableFields) {
// Fields from editable field groups
$groupFields = $this->EditableFieldGroup()->Fields();
$ids = $groupFields->getIDList();
// Set page specific fields
$this->editableFields = $this->Fields();
// Remove all fields that are used to belong to editable field group
// Then sync editable field group with page specific fields
// Else remove all of a group editable fields if exists
if (!empty($ids)) {
$this->editableFields->removeByFilter('"Group" > 0 AND EditableFieldID NOT IN (' . implode(',', $ids) . ')')->addMany($groupFields);
} else {
$this->editableFields->removeByFilter('"Group" > 0');
}
}
return $this->editableFields;
}
/**
* Overload {@link ManyManyList::removeByID()} so we can log
* when a Member is removed from a Group.
*/
public function removeByID($itemID)
{
parent::removeByID($itemID);
if ($this->getJoinTable() == 'Group_Members') {
$currentMember = \Member::currentUser();
if (!($currentMember && $currentMember->exists())) {
return;
}
$member = \Member::get()->byId($itemID);
$group = \Group::get()->byId($this->getForeignID());
if (!$group) {
return;
}
if (!$member) {
return;
}
$this->getAuditLogger()->info(sprintf('"%s" (ID: %s) removed Member "%s" (ID: %s) from Group "%s" (ID: %s)', $currentMember->Email ?: $currentMember->Title, $currentMember->ID, $member->Email ?: $member->Title, $member->ID, $group->Title, $group->ID));
}
}
public function testSubtractOnAManyManyList()
{
$allList = ManyManyList::create('DataObjectTest_Player', 'DataObjectTest_Team_Players', 'DataObjectTest_PlayerID', 'DataObjectTest_TeamID');
$this->assertEquals(3, $allList->count(), 'Precondition; we have all 3 players connected to a team in the list');
$teamOneID = $this->idFromFixture('DataObjectTest_Team', 'team1');
$teamTwoID = $this->idFromFixture('DataObjectTest_Team', 'team2');
// Captain 1 belongs to one team; team1
$captain1 = $this->objFromFixture('DataObjectTest_Player', 'captain1');
$this->assertEquals(array($teamOneID), $captain1->Teams()->column("ID"), 'Precondition; player2 belongs to team1');
// Player 2 belongs to both teams: team1, team2
$player2 = $this->objFromFixture('DataObjectTest_Player', 'player2');
$this->assertEquals(array($teamOneID, $teamTwoID), $player2->Teams()->sort('Title')->column('ID'), 'Precondition; player2 belongs to team1 and team2');
// We want to find the teams for player2 where the captain does not belong to
$teamsWithoutTheCaptain = $player2->Teams()->subtract($captain1->Teams());
// Assertions
$this->assertEquals(1, $teamsWithoutTheCaptain->count(), 'The ManyManyList should onlu contain one team');
$this->assertEquals($teamTwoID, $teamsWithoutTheCaptain->first()->ID, 'The ManyManyList contains the wrong team');
}
public function foreignIDWriteFilter($id = null)
{
return parent::foreignIDFilter($id);
}
/**
* Returns a many-to-many component, as a ManyManyList.
* @param string $componentName Name of the many-many component
* @return ManyManyList The set of components
*
* @todo Implement query-params
*/
public function getManyManyComponents($componentName, $filter = null, $sort = null, $join = null, $limit = null)
{
list($parentClass, $componentClass, $parentField, $componentField, $table) = $this->manyManyComponent($componentName);
if ($filter !== null || $sort !== null || $join !== null || $limit !== null) {
Deprecation::notice('4.0', 'The $filter, $sort, $join and $limit parameters for
DataObject::getManyManyComponents() have been deprecated.
Please manipluate the returned list directly.', Deprecation::SCOPE_GLOBAL);
}
// If we haven't been written yet, we can't save these relations, so use a list that handles this case
if (!$this->ID) {
if (!isset($this->unsavedRelations[$componentName])) {
$this->unsavedRelations[$componentName] = new UnsavedRelationList($parentClass, $componentName, $componentClass);
}
return $this->unsavedRelations[$componentName];
}
$result = ManyManyList::create($componentClass, $table, $componentField, $parentField, $this->manyManyExtraFieldsForComponent($componentName));
if ($this->model) {
$result->setDataModel($this->model);
}
$this->extend('updateManyManyComponents', $result);
// If this is called on a singleton, then we return an 'orphaned relation' that can have the
// foreignID set elsewhere.
return $result->forForeignID($this->ID)->where($filter)->sort($sort)->limit($limit);
}
/**
* Returns a many-to-many component, as a ManyManyList.
* @param string $componentName Name of the many-many component
* @return ManyManyList The set of components
*
* @todo Implement query-params
*/
public function getManyManyComponents($componentName, $filter = "", $sort = "", $join = "", $limit = "") {
list($parentClass, $componentClass, $parentField, $componentField, $table) = $this->many_many($componentName);
$result = new ManyManyList($componentClass, $table, $componentField, $parentField,
$this->many_many_extraFields($componentName));
if($this->model) $result->setModel($this->model);
// If this is called on a singleton, then we return an 'orphaned relation' that can have the
// foreignID set elsewhere.
$result->setForeignID($this->ID);
return $result->where($filter)->sort($sort)->limit($limit);
}
public function testAppendExtraFieldsToQuery()
{
$list = new ManyManyList('ManyManyListTest_ExtraFields', 'ManyManyListTest_ExtraFields_Clients', 'ManyManyListTest_ExtraFieldsID', 'ChildID', array('Worth' => 'Money', 'Reference' => 'Varchar'));
// ensure that ManyManyListTest_ExtraFields_Clients.ValueCurrency is
// selected.
$db = DB::get_conn();
$expected = 'SELECT DISTINCT "ManyManyListTest_ExtraFields_Clients"."WorthCurrency",' . ' "ManyManyListTest_ExtraFields_Clients"."WorthAmount", "ManyManyListTest_ExtraFields_Clients"."Reference",' . ' "ManyManyListTest_ExtraFields"."ClassName", "ManyManyListTest_ExtraFields"."LastEdited",' . ' "ManyManyListTest_ExtraFields"."Created", "ManyManyListTest_ExtraFields"."ID",' . ' CASE WHEN "ManyManyListTest_ExtraFields"."ClassName" IS NOT NULL THEN' . ' "ManyManyListTest_ExtraFields"."ClassName" ELSE ' . Convert::raw2sql('ManyManyListTest_ExtraFields', true) . ' END AS "RecordClassName" FROM "ManyManyListTest_ExtraFields" INNER JOIN' . ' "ManyManyListTest_ExtraFields_Clients" ON' . ' "ManyManyListTest_ExtraFields_Clients"."ManyManyListTest_ExtraFieldsID" =' . ' "ManyManyListTest_ExtraFields"."ID"';
$this->assertSQLEquals($expected, $list->sql($parameters));
}
public function add($item, $extraFields = null)
{
// Get Group.ID
$itemID = null;
if (is_numeric($item)) {
$itemID = $item;
} else {
if ($item instanceof Group) {
$itemID = $item->ID;
}
}
// Check if this group is allowed to be added
if ($this->canAddGroups(array($itemID))) {
parent::add($item, $extraFields);
}
}
public function foreignIDWriteFilter($id = null)
{
// Use the ManyManyList::foreignIDFilter rather than the one
// in this class, otherwise we end up selecting all inherited groups
return parent::foreignIDFilter($id);
}
public function remove($item)
{
$this->recordManyManyChange(__FUNCTION__, $item);
return parent::remove($item);
}
/**
* @todo Test removeMany() and addMany() on $many_many relationships
*/
function testManyManyRelationships()
{
$player1 = $this->objFromFixture('DataObjectTest_Player', 'player1');
$player2 = $this->objFromFixture('DataObjectTest_Player', 'player2');
$team1 = $this->objFromFixture('DataObjectTest_Team', 'team1');
$team2 = $this->objFromFixture('DataObjectTest_Team', 'team2');
// Test adding single DataObject by reference
$player1->Teams()->add($team1);
$player1->flushCache();
$compareTeams = new ManyManyList('DataObjectTest_Team', 'DataObjectTest_Team_Players', 'DataObjectTest_TeamID', 'DataObjectTest_PlayerID');
$compareTeams->forForeignID($player1->ID);
$compareTeams->byID($team1->ID);
$this->assertEquals($player1->Teams()->column('ID'), $compareTeams->column('ID'), "Adding single record as DataObject to many_many");
// test removing single DataObject by reference
$player1->Teams()->remove($team1);
$player1->flushCache();
$compareTeams = new ManyManyList('DataObjectTest_Team', 'DataObjectTest_Team_Players', 'DataObjectTest_TeamID', 'DataObjectTest_PlayerID');
$compareTeams->forForeignID($player1->ID);
$compareTeams->byID($team1->ID);
$this->assertEquals($player1->Teams()->column('ID'), $compareTeams->column('ID'), "Removing single record as DataObject from many_many");
// test adding single DataObject by ID
$player1->Teams()->add($team1->ID);
$player1->flushCache();
$compareTeams = new ManyManyList('DataObjectTest_Team', 'DataObjectTest_Team_Players', 'DataObjectTest_TeamID', 'DataObjectTest_PlayerID');
$compareTeams->forForeignID($player1->ID);
$compareTeams->byID($team1->ID);
$this->assertEquals($player1->Teams()->column('ID'), $compareTeams->column('ID'), "Adding single record as ID to many_many");
// test removing single DataObject by ID
$player1->Teams()->removeByID($team1->ID);
$player1->flushCache();
$compareTeams = new ManyManyList('DataObjectTest_Team', 'DataObjectTest_Team_Players', 'DataObjectTest_TeamID', 'DataObjectTest_PlayerID');
$compareTeams->forForeignID($player1->ID);
$compareTeams->byID($team1->ID);
$this->assertEquals($player1->Teams()->column('ID'), $compareTeams->column('ID'), "Removing single record as ID from many_many");
// Set a many-many relationship by and idList
$player1->Teams()->setByIdList(array($team1->ID, $team2->ID));
$this->assertEquals(array($team1->ID, $team2->ID), $player1->Teams()->column());
$player1->Teams()->setByIdList(array($team1->ID));
$this->assertEquals(array($team1->ID), $player1->Teams()->column());
$player1->Teams()->setByIdList(array($team2->ID));
$this->assertEquals(array($team2->ID), $player1->Teams()->column());
}
public function remove($item)
{
parent::remove($item);
PublisherSubscriberManager::getInstance()->publish('manymanylist_removed_item', array($this, $item));
}
/**
* Returns a many-to-many component, as a ManyManyList.
* @param string $componentName Name of the many-many component
* @return ManyManyList The set of components
*/
public function getManyManyComponents($componentName)
{
$manyManyComponent = $this->manyManyComponent($componentName);
if (!$manyManyComponent) {
throw new InvalidArgumentException(sprintf("DataObject::getComponents(): Unknown many-to-many component '%s' on class '%s'", $componentName, $this->class));
}
list($parentClass, $componentClass, $parentField, $componentField, $table) = $manyManyComponent;
// If we haven't been written yet, we can't save these relations, so use a list that handles this case
if (!$this->ID) {
if (!isset($this->unsavedRelations[$componentName])) {
$this->unsavedRelations[$componentName] = new UnsavedRelationList($parentClass, $componentName, $componentClass);
}
return $this->unsavedRelations[$componentName];
}
$extraFields = $this->manyManyExtraFieldsForComponent($componentName) ?: array();
/** @var ManyManyList $result */
$result = ManyManyList::create($componentClass, $table, $componentField, $parentField, $extraFields);
if ($this->model) {
$result->setDataModel($this->model);
}
$this->extend('updateManyManyComponents', $result);
// If this is called on a singleton, then we return an 'orphaned relation' that can have the
// foreignID set elsewhere.
return $result->setDataQueryParam($this->getInheritableQueryParams())->forForeignID($this->ID);
}
