Container
[ class tree: Container ] [ index: Container ] [ all elements ]

Class: Mai_Container_Sentence

Source Location: /Mai/Container/Sentence.php

Class Overview


Mai_Container_Sentence is a container for a sentence.


Author(s):

  • Wouter Bulten (wouterbulten@mai-ai.org)

Copyright:

  • Copyright (C) 2009 Mai (Me Artificial Intelligence)

Implements interfaces:

Variables

Methods



Class Details

[line 50]
Mai_Container_Sentence is a container for a sentence.



Tags:

author:  Wouter Bulten (wouterbulten@mai-ai.org)
copyright:  Copyright (C) 2009 Mai (Me Artificial Intelligence)
link:  http://www.launchpad.net/mai
license:  GNU General Public License version 3 (GPLv3)


[ Top ]


Class Variables

$_sentenceMark =

[line 60]



Tags:

var:  Sentence mark.
access:  private

Type:   String


[ Top ]

$_words = array()

[line 55]



Tags:

var:  Storage for words.
access:  private

Type:   array


[ Top ]



Class Methods


method getAll [line 108]

array &getAll( )

Return all words (by reference)



Tags:

access:  public


[ Top ]

method getSentenceMark [line 131]

String getSentenceMark( )

Return the sentence mark of this sentence.



Tags:

access:  public



Implementation of:
Mai_Container_Sentence_Interface::getSentenceMark()
[ Top ]

method getWord [line 85]

Mai_Container_Word getWord( Int $location, [Bool $showError = true])

Return a word from storage.



Tags:

access:  public



Implementation of:
Mai_Container_Sentence_Interface::getWord()

Parameters:

Int   $location   The location (key) of storage.
Bool   $showError   Set to false to return false if a word does not excist.

[ Top ]

method insertWord [line 67]

void insertWord( Mai_Container_Word $word, [$location $location = null])

Insert a word in the storage.



Tags:

access:  public



Implementation of:
Mai_Container_Sentence_Interface::insertWord()

Parameters:

Mai_Container_Word   $word   The word to store.
$location   $location   The location (key) where to store.

[ Top ]

method setSentenceMark [line 117]

void setSentenceMark( String $sentenceMark)

Set the sentence mark of this sentence.



Tags:

access:  public



Implementation of:
Mai_Container_Sentence_Interface::setSentenceMark()

Parameters:

String   $sentenceMark  

[ Top ]


Documentation generated on Mon, 27 Jul 2009 19:55:12 +0200 by phpDocumentor 1.4.1