Baigudin Software avatar
Baigudin Software logo
home
ru region
en region

PHP DOM Builder is unveiled in second revision

In 2014 year PHP DOM Builder library was unveiled at the first time within the framework of Baigudin Software project. Two years have been left after that moment and today we are glad to offer the second generation that is PHP DOM Builder Revision 2.

Interface «api::List<Type>»

List interface.

Parameters:
Type — data type of list element.

public:


 virtual                             ~List();

 virtual bool                         add(const Type& element);

 virtual bool                         add(int32 index, const Type& element);

 virtual void                         clear();

 virtual Type                         get(int32 index) const;

 virtual Type                         getFirst() const;

 virtual Type                         getLast() const;

 virtual Type                         illegal() const;

 virtual void                         illegal(const Type value);

 virtual int32                        indexOf(const Type& element) const;

 virtual bool                         isConstructed() const;

 virtual bool                         isEmpty() const;

 virtual bool                         isIllegal(const Type& value) const;

 virtual bool                         isIndex(int32 index) const;

 static bool                          isObject(const Type* obj);

 virtual int32                        length() const;

 virtual ::api::ListIterator<Type>*   listIterator(int32 index);

 virtual bool                         remove(int32 index);

 virtual bool                         removeElement(const Type& element);

 virtual bool                         removeFirst();

 virtual bool                         removeLast();

public: virtual ~List();

Destructor.

public: virtual bool add(const Type& element);

Inserts new element to the end of this container.

Given element will be copied to self items structure by copy constructor calling.

Parameters:
element — inserting element.

Returns:
true if element is added.

public: virtual bool add(int32 index, const Type& element);

Inserts new element to the specified position in this container.

Given element will be copied to self items structure by a copy constructor calling.

Parameters:
index — position in this container.
element — inserting element.

Returns:
true if element is inserted.

public: virtual void clear();

Removes all elements from this container.

public: virtual Type get(int32 index) const;

Returns an element from this container by index.

Parameters:
index — position in this container.

Returns:
indexed element of this container.

public: virtual Type getFirst() const;

Returns the first element in this container.

Returns:
the first element in this container.

public: virtual Type getLast() const;

Returns the last element in this container.

Returns:
the last element in this container.

public: virtual Type illegal() const;

Returns illegal element which will be returned as error value.

Returns:
illegal element.

public: virtual void illegal(const Type value);

Sets illegal element which will be returned as error value.

Parameters:
value — illegal value.

public: virtual int32 indexOf(const Type& element) const;

Returns the index of the first occurrence of the specified element in this container.

Parameters:
element — reference to the element.

Returns:
index or -1 if this container does not contain the element.

public: virtual bool isConstructed() const;

Tests if this object has been constructed.

Returns:
true if object has been constructed successfully.

public: virtual bool isEmpty() const;

Tests if this collection has elements.

Returns:
true if this collection does not contain any elements.

public: virtual bool isIllegal(const Type& value) const;

Tests if given value is an illegal.

Parameters:
value — testing value.
true — if value is an illegal.

public: virtual bool isIndex(int32 index) const;

Tests if given index is available.

Parameters:
index — checking position in this container.

Returns:
true if index is present.

public: static bool isObject(const Type* obj);

Tests if given object has been constructed object.

Parameters:
obj — pointer to object.

Returns:
true if object has been constructed successfully.

public: virtual int32 length() const;

Returns a number of elements in this container.

Returns:
number of elements.

public: virtual ::api::ListIterator<Type>* listIterator(int32 index);

Returns a list iterator of this container elements.

You have to call delete operator for returned iterator after it is used. Given index must not be out of bounds (index < 0 || index > length()).

Parameters:
index — start position in this container.

Returns:
pointer to new list iterator.

public: virtual bool remove(int32 index);

Removes the element at the specified position in this container.

Parameters:
index — position in this container.

Returns:
true if an element is removed successfully.

public: virtual bool removeElement(const Type& element);

Removes the first occurrence of the specified element from this container.

Parameters:
element — reference to element.

Returns:
true if an element is removed successfully.

public: virtual bool removeFirst();

Removes the first element from this container.

Returns:
true if an element is removed successfully.

public: virtual bool removeLast();

Removes the last element from this container.

Returns:
true if an element is removed successfully.

Back to class list