Model/DocumentInterface.php
author ymh <ymh.work@gmail.com>
Tue, 21 Feb 2012 15:15:22 +0100
changeset 74 901463f9b11c
parent 65 ba6b8e38d90e
permissions -rwxr-xr-x
add headers for public repository release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
/*
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
 * This file is part of the WikiTagBundle package.
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 *
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 * (c) IRI <http://www.iri.centrepompidou.fr/>
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 *
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 * For the full copyright and license information, please view the LICENSE
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
 * file that was distributed with this source code.
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
 */
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
namespace IRI\Bundle\WikiTagBundle\Model;
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
14
673b2766024e Update ORM configuration to allow JOIN between Tag and DocumentTag. TagList template has now the number of documents by tag.
cavaliet
parents: 3
diff changeset
    13
use Doctrine\Common\Collections\ArrayCollection;
673b2766024e Update ORM configuration to allow JOIN between Tag and DocumentTag. TagList template has now the number of documents by tag.
cavaliet
parents: 3
diff changeset
    14
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
interface DocumentInterface {
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
    
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
    /**
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
    * Get id
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
    *
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
    * @return integer
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
    */
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
    function getId();
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
    
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    24
    
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
    /**
42
0e57c730bb18 Documentation and add alternative wp url and label + migrations
ymh <ymh.work@gmail.com>
parents: 23
diff changeset
    26
     * Set the external id i.e. the host document id
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
     *
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    28
     * @param text $externalId
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
     */
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    30
    function setExternalId($externalId);
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
    
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
    /**
42
0e57c730bb18 Documentation and add alternative wp url and label + migrations
ymh <ymh.work@gmail.com>
parents: 23
diff changeset
    33
     * Get the external id, i.e. the host document id
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
     */
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    35
    function getExternalId();
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    36
    
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
    
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
    /**
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    39
     * Set manualOrder
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
     *
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    41
     * @param boolean $manualOrder
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
     */
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    43
    function setManualOrder($manualOrder);
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
    
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
    /**
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    46
     * Get manualOrder
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
     *
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    48
     * @return boolean
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
     */
17
81962874e172 First implementation of dynamic fields
ymh <ymh.work@gmail.com>
parents: 3
diff changeset
    50
    function getManualOrder();
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
    
23
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    52
    /**
57
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    53
     * Get the list of tags
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    54
     *
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    55
     * @return array of IRI\Bundle\WikiTagBundle\Model\DocumentTagInterface
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    56
     */
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    57
    function getTags();
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    58
    
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    59
    /**
23
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    60
     * Get tagsStr
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    61
     *
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    62
     * @return string
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    63
     */
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    64
    function getTagsStr();
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
    
23
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    66
    /**
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    67
     * Set tagsStr
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    68
     *
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    69
     * @param $tagsStr
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    70
     */
b435f8055cb4 improve dynamic docs. create and lad class dynamically
ymh <ymh.work@gmail.com>
parents: 20
diff changeset
    71
    function setTagsStr($tagsStr);
62
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    72
    
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    73
   /**
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    74
    * return the utc time when this object has been created
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    75
    */
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    76
    function getCreatedAt();
10be6b9e55e7 add creation timestamp on document tag and document tag
ymh <ymh.work@gmail.com>
parents: 57
diff changeset
    77
    
65
ba6b8e38d90e Correct event mamangement in hdabo_sf
ymh <ymh.work@gmail.com>
parents: 62
diff changeset
    78
    /**
ba6b8e38d90e Correct event mamangement in hdabo_sf
ymh <ymh.work@gmail.com>
parents: 62
diff changeset
    79
     * __toString magic method
ba6b8e38d90e Correct event mamangement in hdabo_sf
ymh <ymh.work@gmail.com>
parents: 62
diff changeset
    80
     */
ba6b8e38d90e Correct event mamangement in hdabo_sf
ymh <ymh.work@gmail.com>
parents: 62
diff changeset
    81
    function __toString();
57
186c4121c7b3 add service tp copy tag from one document to another
ymh <ymh.work@gmail.com>
parents: 42
diff changeset
    82
            
2
13f43f53d0ba first implementation
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
}