Class: Stannum::Associations::Many::Proxy

Parent Namespace

Stannum::Associations::Many

Included Modules

Enumerable

Defined In

lib/stannum/associations/many.rb

Table Of Contents

• Overview
• Constructor
• Instance Methods
  • ==
  • add
  • each
  • initialize
  • inspect
  • remove

Overview

Wrapper object for an entity’s plural association.

Back To Top

Constructor

#initialize(association:, entity:) => Proxy

Parameters

• association (Stannum::Associations::Many) — the association being wrapped.
• entity (Stannum::Entity) — the entity instance whose association is being wrapped.

Returns

• (Proxy) — a new instance of Proxy

Back To Top

Instance Methods

#==(other) => true, false

Parameters

• other (Object) — the object to compare.

Returns

• (true, false) — true if the object has matching data; otherwise false.

#add(value) => self

Also known as: <<, push

Appends the entity to the association.

If the entity is already in the association data, this method does nothing.

Parameters

• value (Stannum::Entity) — the entity to add.

Returns

• (self) — the association proxy.

#each => Enumerator
#each(&block) => Object

Overloads

#each => Enumerator

Returns

• (Enumerator) — an enumerator over each item in the entity's association data.

#each(&block) => Object

Yields

• Yields each item in the entity’s association data.

Yield Parameters

• item (Stannum::Entity) — the associated entity.

#inspect => String

Returns

• (String) — a human-readable string representation of the object.

#remove(value) => self

Also known as: delete

Removes the entity from the association.

If the entity is not in the association data, this method does nothing.

Parameters

• value (Stannum::Entity) — the entity to remove.

Returns

• (self) — the association proxy.

Back To Top

---

Back to Documentation | Reference | Stannum | Stannum::Associations | Stannum::Associations::Many