class Tilia::DavAcl::Xml::Property::CurrentUserPrivilegeSet

CurrentUserPrivilegeSet

This class represents the current-user-privilege-set property. When requested, it contain all the privileges a user has on a specific node.

Attributes

privileges[RW]

List of privileges

@var array

Public Class Methods

new(privileges) click to toggle source

Creates the object

Pass the privileges in clark-notation

@param array privileges

# File lib/tilia/dav_acl/xml/property/current_user_privilege_set.rb, line 27
def initialize(privileges)
  @privileges = privileges
end
xml_deserialize(reader) click to toggle source

The deserialize method is called during xml parsing.

This method is called statictly, this is because in theory this method may be used as a type of constructor, or factory method.

Often you want to return an instance of the current class, but you are free to return other data as well.

You are responsible for advancing the reader to the next element. Not doing anything will result in a never-ending loop.

If you just want to skip parsing for this element altogether, you can just call reader.next

reader.parse_inner_tree will parse the entire sub-tree, and advance to the next element.

@param Reader reader @return mixed

# File lib/tilia/dav_acl/xml/property/current_user_privilege_set.rb, line 91
def self.xml_deserialize(reader)
  result = []

  tree = reader.parse_inner_tree('{DAV:}privilege' => Tilia::Xml::Element::Elements)
  tree.each do |element|
    next unless element['name'] == '{DAV:}privilege'

    result << element['value'][0]
  end
  new(result)
end

Public Instance Methods

has(privilege_name) click to toggle source

Returns true or false, whether the specified principal appears in the list.

@param string privilege_name @return bool

# File lib/tilia/dav_acl/xml/property/current_user_privilege_set.rb, line 61
def has(privilege_name)
  @privileges.include?(privilege_name)
end
to_html(html) click to toggle source

Generate html representation for this value.

The html output is 100% trusted, and no effort is being made to sanitize it. It's up to the implementor to sanitize user provided values.

The output must be in UTF-8.

The baseUri parameter is a url to the root of the application, and can be used to construct local links.

@param HtmlOutputHelper html @return string

# File lib/tilia/dav_acl/xml/property/current_user_privilege_set.rb, line 115
def to_html(html)
  props = @privileges.map do |property|
    html.xml_name(property)
  end
  props.join(', ')
end
value() click to toggle source

Returns the list of privileges.

@return array

# File lib/tilia/dav_acl/xml/property/current_user_privilege_set.rb, line 68
def value
  @privileges
end
xml_serialize(writer) click to toggle source

The xmlSerialize metod is called during xml writing.

Use the writer argument to write its own xml serialization.

An important note: do not create a parent element. Any element implementing XmlSerializble should only ever write what's considered its 'inner xml'.

The parent of the current element is responsible for writing a containing element.

This allows serializers to be re-used for different element names.

If you are opening new elements, you must also close them again.

@param Writer writer @return void

# File lib/tilia/dav_acl/xml/property/current_user_privilege_set.rb, line 48
def xml_serialize(writer)
  @privileges.each do |priv_name|
    writer.start_element('{DAV:}privilege')
    writer.write_element(priv_name)
    writer.end_element
  end
end