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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
|
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// Copyright : (C) 2015 Eran Ifrah
// File name : PHPEntityFunction.h
//
// -------------------------------------------------------------------------
// A
// _____ _ _ _ _
// / __ \ | | | | (_) |
// | / \/ ___ __| | ___| | _| |_ ___
// | | / _ \ / _ |/ _ \ | | | __/ _ )
// | \__/\ (_) | (_| | __/ |___| | || __/
// \____/\___/ \__,_|\___\_____/_|\__\___|
//
// F i l e
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#ifndef PHPENTITYFUNCTION_H
#define PHPENTITYFUNCTION_H
#include "codelite_exports.h"
#include "PHPEntityBase.h" // Base class: PHPEntityBase
#include <vector>
class WXDLLIMPEXP_CL PHPEntityFunction : public PHPEntityBase
{
public:
virtual wxString FormatPhpDoc(const CommentConfigData& data) const;
virtual wxString GetDisplayName() const;
virtual bool Is(eEntityType type) const;
virtual wxString Type() const;
virtual void FromResultSet(wxSQLite3ResultSet& res);
virtual void PrintStdout(int indent) const;
void FromJSON(const JSONItem& json);
JSONItem ToJSON() const;
protected:
// The local variabels defined in this function of type
// PHPEntityVariable
PHPEntityBase::List_t m_locals;
// the return value as read from the database
wxString m_strReturnValue;
// the signature
wxString m_strSignature;
public:
PHPEntityFunction();
virtual ~PHPEntityFunction();
const wxString& GetReturnValue() const { return m_strReturnValue; }
void SetReturnValue(const wxString& strReturnValue) { this->m_strReturnValue = strReturnValue; }
wxString GetScope() const;
/**
* @brief format function signature
*/
wxString GetSignature() const;
/**
* @brief return the full path for this function
* Example: \path\toClass::functionName($a, $b)
*/
wxString GetFullPath() const;
/**
* @brief write this object into the database
* @param db
*/
virtual void Store(PHPLookupTable* lookup);
virtual wxString ToTooltip() const;
};
#endif // PHPENTITYFUNCTION_H
|