module Oid::Relationships(T)

Direct including types

• Oid::RenderableEntity

Defined in:

Instance Method Summary

• #_parent=(parent : T)

  Set the parent

• #add_child(child : T)

  Add provided object as a child and set self as parent to object

• #child_of?(parent : T) : Bool

  Is this object a child of parent?

• #children? : Bool

  Check if children are present

• #children_count

  Returns the total count of children

• #clear_on_child_added_hooks
• #clear_parent!

  Removes parent from self

• #delete_child(child : T)

  Removes child from self

• #each_child(&block : T -> Nil)

  Yields each T child to provided block

• #get_child(kind)
• #has_child?(child : T) : Bool

  Returns a Bool value that indicates whether the object is a direct child of self.

• #has_parent?(parent : T) : Bool

  Returns a Bool value that indicates whether the object is a direct parent of self.

• #on_child_added(&block : T, T -> Nil)
• #parent : T
• #parent? : Bool

  Check if parent is set

• #parent_of?(child : T) : Bool

  Is this object a parent of child?

• #related?(other : T)
• #relationship_to(other : T)

  Will return a symbol of the relationship of self to other.

• #remove_on_child_added_hook(hook : Proc(T, T, Nil))
• #root : T

  Returns the top-most parent of the objects relationships

Instance Method Detail

class RelTestObj
  include Oid::Helpers::Relationships(RelTestObj)
end

parent = RelTestObj.new
child = RelTestObj.new
orphan = RelTestObj.new

parent.add_child(child)

parent.relationship_to(child)  # => :parent
child.relationship_to(parent)  # => :child
parent.relationship_to(orphan) # => :none
child.relationship_to(orphan)  # => :none