summaryrefslogtreecommitdiff
path: root/include/countable.h
blob: 8ff0c61f5fd88688a275be0249ac8e56a40ff3b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
/**
 *  Countable.h
 *
 *  "Interface" that can be "implemented" by your class. If you do, you
 *  create your class like this:
 *
 *  class MyClass : public Php::Base, public Php::Countable { ... }
 *
 *  You will have to implement the count() method, which should return the
 *  number of elements in the object
 *
 *  @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
 *  @copyright 2014 Copernica BV
 */

/**
 *  Set up namespace
 */
namespace Php {

/**
 *  Class definition
 */
class PHPCPP_EXPORT Countable
{
public:
    /**
     *  Retrieve the number of items in the class
     *  @return long
     */
    virtual long count() = 0;

};

/**
 *  End namespace
 */
}